Commit Graph

71 Commits

Author SHA1 Message Date
1f29b07f39 docs: restore getting-started guide & module index
These two files were removed in ccb5fde9bcc on the rewrite-docs branch,
which was merged in 1f8bf7accb. I planned to add their rewritten
versions soon after, but life and distractions got in the way, so I'm
restoring the old ones until I finish the new ones.

Fix: #6748
Fix: #6723
Fix: #6671
Fix: #6631
Close: #6726
Revert: ccb5fde99b
2022-09-06 22:55:47 +02:00
ccb5fde99b docs: delete old org files
These will be replaced soon (or in modules.org case, they already have,
in 2636fbc).

Ref: 2636fbc36f54
2021-11-21 20:04:28 +01:00
02c578f95c docs: add emacs26 removal for ubuntu to install guide
In some cases, ubuntu may contain a preinstalled version of Emacs26,
which cannot be simply removed with "sudo apt remove emacs", and needs
additional "sudo apt autoremove" to properly uninstall emacs26. Only
this will result with the command "emacs" opening other version than
emacs26.

Ref https://unix.stackexchange.com/a/84488
Close #5336
2021-08-03 10:49:33 -04:00
d217ae3343 getting_started.org: use Emacs v27.x or later 2021-07-22 20:12:54 -06:00
a7268ce4cb Merge branch 'hlissner:develop' into develop 2021-07-22 20:06:24 -06:00
044a1a5f2b Drop Emacs 26.x support
Emacs 27.x has been the stable version of Emacs for nearly a year, and
introduces a litany of bugfixes, performance, and quality-of-life
improvements that significantly reduce Doom's maintenance burden (like
XDG support, early-init.el, image manipulation without imagemagick, a
native JSON library, harfbuzz support, pdumper, and others).

With so many big changes on Doom's horizon, I like having one less (big)
thing to worry about.

Also reverts bb677cf7a (#5232) as it is no longer needed.
2021-07-06 02:31:52 -04:00
2d53f12f1c getting_started.org: Gentoo xft and gui flags
As suggested by @TheGreatMcPain here: https://github.com/hlissner/doom-emacs/pull/5165#issuecomment-863747913
2021-06-24 05:41:38 -06:00
cdf7846e3c getting_started.org: Gentoo Linux install guide 2021-06-09 21:00:56 -06:00
1a5f4afd0d Reduce minimum required git to 2.23
Thanks to raxod502/straight.el@7ca94a7, which was included in 3329448bd.
This in particular reduces the burden for Ubuntu users.

Relevant to #5088, #5096
2021-06-01 16:08:17 -04:00
7ec9221957 docs/getting_started: update ubuntu install instructions
To include git 2.28 install instructions (see #5088).

Also update version tags (to push 27.x over 26.x).
2021-05-24 15:08:42 -04:00
2d8342ca5f docs: bump minimum git version: 2.23 -> 2.28 #5088
And bump recommended Emacs: 27.1 -> 27.2
2021-05-24 14:41:16 -04:00
311d492c77 Merge pull request #4663 from dabrahams/patch-3
Full-throated recommendation of emacs-mac
2021-02-23 19:43:16 -05:00
8f3a9d5fda Merge pull request #4653 from dabrahams/patch-1
Fix a broken link
2021-02-23 19:39:45 -05:00
a123dfdf7f Fix a link 2021-02-17 15:48:58 -08:00
3e5ccb4963 Update instructions for Chemacs2
Chemacs doesn't works since early-init.el was introduced
2021-02-17 15:46:32 -08:00
e4cbd18f4c Full-throated recommendation of emacs-mac
When installed via homebrew, the formula adds this patch
https://bitbucket.org/mituharu/emacs-mac/pull-requests/2/add-multi-tty-support-to-be-on-par-with/diff, which purports to solve the multi-tty issue.  The user experience I've had with emacs-plus is not a good one.
2021-02-16 11:37:25 -08:00
3b188412b5 Fix a broken link 2021-02-15 16:18:21 -08:00
d0b6cef8a5 Bump minimum supported version to Emacs 26.3
From 26.1, which we no longer officially* support.

*I won't be implementing any hard checks for it just yet though. I just
want to push this forward while I plan to drop 26.x support later this
year.
2021-02-05 04:51:24 -05:00
c3c001ad7d Bump core
domtronn/all-the-icons.el@c795d0f -> domtronn/all-the-icons.el@5fa7283
hlissner/emacs-so-long@ed666b0 -> emacs-straight/so-long@a5d445d
jwiegley/use-package@365c73d -> jwiegley/use-package@317137b
raxod502/straight.el@ac4df5c -> raxod502/straight.el@f2cb888

+ Complain if :no-byte-compile, :no-native-compile, or :no-build are
  used in package!. Straight replaced them with :build (and the old
  :build was renamed to :pre-build). See raxod502/straight.el@6a273d1
+ Update getting_started.org to mention :build
+ Switch to emacs-straight/so-long so I don't have to maintain my mirror
  anymore.
2021-02-04 07:32:26 -05:00
3cae62cacf Fix typos in docs/getting_started.org 2020-12-20 11:58:48 +03:00
6774c0d26e Replace +auto -> +childframe in code example
+auto was removed in 04acb8fa9
2020-11-27 22:20:51 -05:00
eb720c86d6 Merge pull request #4016 from harryvederci/patch-1
Fix conflicting text formats in "getting started" steps.
2020-10-04 20:00:01 -04:00
40898b34bf Remove conflicting formats
Remove fat formatting that interferes with inner monospace/code formatted text.

This caused "=" and "~" signs to be displayed (at least in the browser, on the github readme page).
2020-10-03 17:49:19 +01:00
c849db6417 Fix link in gettting_started.org
Original link to company module in section "Writing your own modules" was pointing to a malformed path. This changes it to point to the correct path of the company module readme.
2020-09-01 12:27:14 -04:00
ed2c750023 docs/getting_started: clarify "using local packages" #3842 2020-08-26 14:25:46 -04:00
7c69c7b7b5 ArchLinux packages now have 27.1 as default
https://www.archlinux.org/packages/extra/x86_64/emacs/

We could point to emacs-git AUR package for emacs 28:
https://aur.archlinux.org/packages/emacs-git/

But I think the reference to emacs 27 was there simply because emacs 27
is the recommended version so I didn't include a replacement AUR link in
this PR.
2020-08-19 15:37:58 -10:00
6510c13136 Updates getting_started.org.
Emacs 27.1 has been released & emacs-plus now installs 27.x by default:

  https://github.com/d12frosted/homebrew-emacs-plus
2020-08-11 19:15:42 +01:00
e07cc77c19 docs/getting_started: clarify ~/.emacs.d/bin entry in PATH
I took this for granted:

Works:
  export PATH=~/.emacs.d/bin:$PATH
  export PATH="$HOME/.emacs.d/bin:$PATH"

Does not work:
  export PATH="~/.emacs.d/bin:$PATH"
2020-07-31 18:18:07 -04:00
69ce5d5ea0 docs/getting_started: update ToC 2020-07-26 02:59:05 -04:00
135929d4ae docs/getting_started: fix heading hierarchy 2020-07-26 02:58:15 -04:00
8c2026b4ab docs/getting_started: revise & expand "Writing your own modules" 2020-07-26 02:56:27 -04:00
976a601750 docs/getting_started: add install guides for Windows
Closes #3444
Closes #2575
2020-07-24 01:49:59 -04:00
87d17fab8c docs/getting_started: general revision
An effort to make our documentation clearer, more concise in places,
simpler where possible and highlight caveats so folks aren't caught by
surprise by strange behavior.

- Remove --with-modern-cg433n-icon (#3554), as the default icon is a
  reasonable default, and I'd like to keep things simple.
- Mention "could not find package in recipe repositories" error and what
  to do about it.
- Mention that 'doom sync -u' is necessary for Doom's package manager to
  see recipe changes.
- Mention :no-byte-compile for installing local packages; to save you
  the hassle of running 'doom sync' every time you change them.
- Clarify Emacs 27 install instructions where possible (particularly for
  nixOS and Ubuntu)
2020-07-24 01:49:58 -04:00
fc2634d67b docs/getting_started: fix doom/help-{modules,autodefs} keybinds
Relevant to #3580
2020-07-17 20:13:14 -04:00
9518852597 docs/getting_started: update help keybinds
Closes #3580

Co-authored-by: Logan Barnett <logustus@gmail.com>
2020-07-17 19:40:24 -04:00
c280480262 Fix links to work on github and on code 2020-07-13 20:24:35 -03:00
73e439084d Update Mac Install for emacs-plus
The parameter is wrong. It must be --with-modern-cg433n-icon and not --with-modern-icon-cg433n

You can check it on the github repo site https://github.com/d12frosted/homebrew-emacs-plus
2020-07-05 21:39:19 +02:00
a15d31c9d4 Fix link to screenshots + minor correction in "Getting started" 2020-06-19 22:17:02 +02:00
b5be860033 Change emacs-plus icon
Change the emacs-plus icon from spacemac's logo to a more neutral modern emacs icon.
2020-06-17 19:41:38 +02:00
b445038817 Fix scoop install instructions
Just tried installing on Windows, you need to use "scoop bucket add extras" not "scoop enable extras"
2020-05-19 21:42:58 +01:00
d0a3e9260c add openSUSE installation section to getting started guide 2020-05-18 15:10:34 +08:00
a4f4937931 Add --with-modules to emacs-mac documenation
Default options for brew install emacs-mac compile wihtout
modules preventing to use vterm.
2020-05-17 00:44:52 +02:00
f2d6230736 Fix use-packages! typo in getting started 2020-05-12 13:41:13 -06:00
e8040c29b0 Adding Fedora dependencies in getting_started doc 2020-05-04 21:24:12 +02:00
be396655c4 Render 'export PATH' line correctly in docs
Github renders double quotes in blockquotes with fancy curly (unicode)
quotes. If folks copy this to their shell configs, they'll get weird
PATH bugs!

Seems neither org nor github can handle ~...~ syntax if either tilde is
adjacent to a non-alphanumeric (like double quotes), so I just did away
with them altogether.
2020-05-03 21:30:41 -04:00
916ef0fbbe Rename unmap! to undefine-key!
unmap! gives the false impression that it is related or similar to map!,
but it isn't.
2020-04-23 23:56:17 -04:00
508f6f5594 Merge pull request #2851 from tbille/patch-1
Fix install link
2020-04-08 15:35:58 -04:00
63a71ec90f Discourage unpinning all packages 2020-04-08 15:30:04 -04:00
fe458a214d Fix install link 2020-04-08 16:54:44 +01:00
776c010cb5 Fix internal documentation links containing "%20"
These links to org headers didn't work for me when they contain %20
instead of space.
2020-03-09 15:31:57 -04:00