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

Use valid shell commands

Browse source 
By not prepending `$` to your examples users can copy them easier
without fear of seeing `bash: $: command not found` or similar
This commit is contained in:
Josh Hoff 2013-06-01 12:57:39 -05:00
parent f0b786c452
commit 6ebfe1c800
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -20,7 +20,7 @@ can skip the whole manual and just type in your favorite shell the
following command: following command:
```bash ```bash
$ curl -L http://git.io/epre | sh curl -L http://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,
@ -31,13 +31,13 @@ source repository and the installation directory. To change the
installation directory: installation directory:
```bash ```bash
$ 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 ```bash
$ 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
@ -65,7 +65,7 @@ You can install **Emacs Prelude** via the command line with either `curl` or
If you're using `curl` type the following command: If you're using `curl` type the following command:
```bash ```bash
$ curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
``` ```
#### Via Wget #### Via Wget
@ -73,15 +73,15 @@ $ curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
If you're using `wget` type: If you're using `wget` type:
```bash ```bash
$ wget --no-check-certificate https://github.com/bbatsov/prelude/raw/master/utils/installer.sh -O - | sh wget --no-check-certificate https://github.com/bbatsov/prelude/raw/master/utils/installer.sh -O - | sh
``` ```
### Manual ### Manual
```bash ```bash
$ git clone git://github.com/bbatsov/prelude.git path/to/local/repo git clone git://github.com/bbatsov/prelude.git path/to/local/repo
$ ln -s path/to/local/repo ~/.emacs.d ln -s path/to/local/repo ~/.emacs.d
$ cd ~/.emacs.d cd ~/.emacs.d
``` ```
You'd do well to replace `~/.emacs.d` with the value of You'd do well to replace `~/.emacs.d` with the value of
@ -93,8 +93,8 @@ You'd do well to replace `~/.emacs.d` with the value of
The update procedure is fairly straightforward: The update procedure is fairly straightforward:
```bash ```bash
$ cd path/to/prelude/installation cd path/to/prelude/installation
$ git pull git pull
``` ```
The `path/to/prelude/installation` is usually `~/.emacs.d` (at least The `path/to/prelude/installation` is usually `~/.emacs.d` (at least
@ -152,15 +152,15 @@ Nothing fancy here. Just start Emacs as usual. Personally I run Emacs
in daemon mode: in daemon mode:
```bash ```bash
$ 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 ```bash
$ 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
@ -379,7 +379,7 @@ system. You can install `aspell` and the dictionary on OS X with
`homebrew` like this: `homebrew` like this:
```bash ```bash
$ brew install aspell --with-lang=en brew install aspell --with-lang=en
``` ```
On Linux distros - just use your distro's package manager. On Linux distros - just use your distro's package manager.
@ -390,7 +390,7 @@ If your Emacs looks considerably uglier in a terminal (compared to the
GUI version) try adding this to your `.bashrc` or `.zshrc`: GUI version) try adding this to your `.bashrc` or `.zshrc`:
```bash ```bash
$ export TERM=xterm-256color export TERM=xterm-256color
``` ```
Source the `.bashrc` file and start Emacs again. Source the `.bashrc` file and start Emacs again.