jt/emacs-prelude
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve the docs here and there

Browse source
This commit is contained in:
Bozhidar Batsov 2020-09-03 09:22:32 +03:00
parent dd972f2031
commit b003f56c62
3 changed files with 24 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -15,6 +15,7 @@ Prelude is compatible **ONLY with GNU Emacs 25.1+**. In general you're
advised to always run Prelude with the latest stable Emacs release. advised to always run Prelude with the latest stable Emacs release.
You can support the development of Prelude via You can support the development of Prelude via
[GitHub Sponsors](https://github.com/sponsors/bbatsov),
[PayPal](https://www.paypal.me/bbatsov) and [PayPal](https://www.paypal.me/bbatsov) and
[Patreon](https://www.patreon.com/bbatsov). [Patreon](https://www.patreon.com/bbatsov).
@ -22,6 +23,7 @@ You can support the development of Prelude via
* Improved UX, that's still in line with Emacs traditions * Improved UX, that's still in line with Emacs traditions
* Sane defaults of baseline Emacs functionality * Sane defaults of baseline Emacs functionality
* Automatic installation of many major programming modes on demand
* A curated set of 3rd party packages to enhance the base functionality * A curated set of 3rd party packages to enhance the base functionality
* Simple modular architecture * Simple modular architecture
* Easy customization * Easy customization
@ -33,8 +35,8 @@ etc), you already have a recent version of Emacs installed, as well as `git` & `
can skip the whole manual and just type in your favorite shell the can skip the whole manual and just type in your favorite shell the
following command: following command:
```bash ```shellsession
curl -L https://git.io/epre | sh $ curl -L https://git.io/epre | sh
``` ```
You can now power up your Emacs, sit back and enjoy Prelude. You can now power up your Emacs, sit back and enjoy Prelude.
@ -43,14 +45,14 @@ There are two environment variables you can use to control the
source repository and the installation directory. To change the source repository and the installation directory. To change the
installation directory: installation directory:
```bash ```shellsession
export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh $ export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
``` ```
To change the source repository: To change the source repository:
```bash ```shellsession
export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh $ export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
``` ```
Note that the installer will back up any existing `.emacs` file or Note that the installer will back up any existing `.emacs` file or

1
doc/index.md
View file

@ -21,6 +21,7 @@ You can support the development of Prelude via
* Improved UX, that's still in line with Emacs traditions * Improved UX, that's still in line with Emacs traditions
* Sane defaults of baseline Emacs functionality * Sane defaults of baseline Emacs functionality
* Automatic installation of many major programming modes on demand
* A curated set of 3rd party packages to enhance the base functionality * A curated set of 3rd party packages to enhance the base functionality
* Simple modular architecture * Simple modular architecture
* Easy customization * Easy customization

30
doc/usage.md
View file

@ -5,16 +5,16 @@
Nothing fancy here. Just start Emacs as usual. Personally I run Emacs Nothing fancy here. Just start Emacs as usual. Personally I run Emacs
in daemon mode: in daemon mode:
```bash ```shellsession
emacs --daemon $ emacs --daemon
``` ```
Afterwards I connect to the server with either a terminal or a GUI Afterwards I connect to the server with either a terminal or a GUI
client like this: client like this:
```bash ```shellsession
emacsclient -t $ emacsclient -t
emacsclient -c $ emacsclient -c
``` ```
You'd probably do well to put a few aliases in your `.zshrc` (or You'd probably do well to put a few aliases in your `.zshrc` (or
@ -32,8 +32,8 @@ the command line using `vi(m)`.
You can also open a file with the cursor positioned directly on a specific line: You can also open a file with the cursor positioned directly on a specific line:
```bash ```shellsession
emacsclient somefile:1234 $ emacsclient somefile:1234
``` ```
This will open file `somefile` and set cursor on line 1234. This will open file `somefile` and set cursor on line 1234.
@ -262,20 +262,20 @@ Use `C-h k <key>` (`<key>` are the ones listed on the left) or `C-h f <function>
#### PDF generation #### PDF generation
Install [LaTeX](https://www.latex-project.org/get/) To generate a PDF version of the cheatsheet you'll need to install [LaTeX](https://www.latex-project.org/get/). Afterwards you can do something like:
```bash ```shellsession
cd modules/doc $ cd modules/doc
pdflatex prelude-cheatsheet.tex $ pdflatex prelude-cheatsheet.tex
``` ```
#### PNG generation #### PNG generation
Install [Poppler](https://poppler.freedesktop.org/) To generate a PDF version of the cheatsheet you'll need to install [Poppler](https://poppler.freedesktop.org/). Afterwards you can do something like:
```bash ```shellsession
cd modules/doc $ cd modules/doc
pdftocairo -png -singlefile prelude-cheatsheet.pdf cheatsheet $ pdftocairo -png -singlefile prelude-cheatsheet.pdf cheatsheet
``` ```
## Automatic package installation ## Automatic package installation