From f0b786c452600d53d83a5040d2b60eeb18b731ab Mon Sep 17 00:00:00 2001 From: Josh Hoff Date: Sat, 1 Jun 2013 12:56:17 -0500 Subject: [PATCH 1/2] Vanity URL for the installer Made with `https://github.com/bbatsov/prelude/raw/master/utils/installer.sh` More info: https://github.com/bbatsov/prelude/raw/master/utils/installer.sh --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 723abeb..18c5d9c 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ can skip the whole manual and just type in your favorite shell the following command: ```bash -$ curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh +$ curl -L http://git.io/epre | sh ``` You can now power up your Emacs, sit back and enjoy Prelude, From 6ebfe1c800ef12536bc7b24de33b80bc185e86b5 Mon Sep 17 00:00:00 2001 From: Josh Hoff Date: Sat, 1 Jun 2013 12:57:39 -0500 Subject: [PATCH 2/2] Use valid shell commands By not prepending `$` to your examples users can copy them easier without fear of seeing `bash: $: command not found` or similar --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 18c5d9c..7f18fb2 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ can skip the whole manual and just type in your favorite shell the following command: ```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, @@ -31,13 +31,13 @@ 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 +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 +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 @@ -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: ```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 @@ -73,15 +73,15 @@ $ curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh If you're using `wget` type: ```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 ```bash -$ git clone git://github.com/bbatsov/prelude.git path/to/local/repo -$ ln -s path/to/local/repo ~/.emacs.d -$ cd ~/.emacs.d +git clone git://github.com/bbatsov/prelude.git path/to/local/repo +ln -s path/to/local/repo ~/.emacs.d +cd ~/.emacs.d ``` 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: ```bash -$ cd path/to/prelude/installation -$ git pull +cd path/to/prelude/installation +git pull ``` 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: ```bash -$ emacs --daemon +emacs --daemon ``` Afterwards I connect to the server with either a terminal or a GUI client like this: ```bash -$ emacsclient -t -$ emacsclient -c +emacsclient -t +emacsclient -c ``` 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: ```bash -$ brew install aspell --with-lang=en +brew install aspell --with-lang=en ``` 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`: ```bash -$ export TERM=xterm-256color +export TERM=xterm-256color ``` Source the `.bashrc` file and start Emacs again.