diff --git a/README.md b/README.md index 2956adb..7895e57 100644 --- a/README.md +++ b/README.md @@ -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. You can support the development of Prelude via +[GitHub Sponsors](https://github.com/sponsors/bbatsov), [PayPal](https://www.paypal.me/bbatsov) and [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 * 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 * Simple modular architecture * 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 following command: -```bash -curl -L https://git.io/epre | sh +```shellsession +$ curl -L https://git.io/epre | sh ``` 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 installation directory: -```bash -export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh +```shellsession +$ 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: -```bash -export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh +```shellsession +$ 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 diff --git a/doc/index.md b/doc/index.md index 463d4df..5949522 100644 --- a/doc/index.md +++ b/doc/index.md @@ -21,6 +21,7 @@ You can support the development of Prelude via * Improved UX, that's still in line with Emacs traditions * 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 * Simple modular architecture * Easy customization diff --git a/doc/usage.md b/doc/usage.md index 1a3a1ab..38f5ee6 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -5,16 +5,16 @@ Nothing fancy here. Just start Emacs as usual. Personally I run Emacs in daemon mode: -```bash -emacs --daemon +```shellsession +$ emacs --daemon ``` Afterwards I connect to the server with either a terminal or a GUI client like this: -```bash -emacsclient -t -emacsclient -c +```shellsession +$ emacsclient -t +$ emacsclient -c ``` 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: -```bash -emacsclient somefile:1234 +```shellsession +$ emacsclient somefile:1234 ``` This will open file `somefile` and set cursor on line 1234. @@ -262,20 +262,20 @@ Use `C-h k ` (`` are the ones listed on the left) or `C-h f #### 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 -cd modules/doc -pdflatex prelude-cheatsheet.tex +```shellsession +$ cd modules/doc +$ pdflatex prelude-cheatsheet.tex ``` #### 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 -cd modules/doc -pdftocairo -png -singlefile prelude-cheatsheet.pdf cheatsheet +```shellsession +$ cd modules/doc +$ pdftocairo -png -singlefile prelude-cheatsheet.pdf cheatsheet ``` ## Automatic package installation