From 7c305b32dedba3ca0f74b537af2e061af415e502 Mon Sep 17 00:00:00 2001 From: Taylor Lapeyre Date: Wed, 10 Apr 2013 14:04:45 -0500 Subject: [PATCH] update README --- README.markdown | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/README.markdown b/README.markdown index 1c75e5e..bfff786 100644 --- a/README.markdown +++ b/README.markdown @@ -7,27 +7,39 @@ 1. Install [git][2] and [jekyll][3]. 2. Clone this repository to your computer: - - `$ git clone git@github.com:lbrn/lbrn-jekyll.git` + ``` bash + $ git clone git@github.com:lbrn/lbrn-jekyll.git + ``` 3. Create and add a pubic SSH key so that you can easily deploy to Github: - - `$ ssh-keygen -t rsa -C "your_email@example.com"` *(simply press enter until it finishes)* - - Copy the contents of ~/.ssh/id_rsa.pub` and add the key [here][4] + ```bash + $ ssh-keygen -t rsa -C "your_email@example.com" + ``` + Simply press enter until it finishes, and then copy the contents of `~/.ssh/id_rsa.pub` and add the key [here][4]. 3. Add the LBRN Server so that you can deploy: - - `$ git remote add server lbrn@test.lbrn.lsu.edu:~/lbrn-jekyll.git` + ```bash + $ git remote add server lbrn@test.lbrn.lsu.edu:~/lbrn-jekyll.git + ``` #### Editing The Site -1. You can use `$ jekyll --server --auto` to see your changes on localhost:4000 while you develop. Press Ctrl+C to end. -2. Edit the site using whatever editor you like. When you are satisfied with your change, add your changed files... - - `$ git add --all` +1. You can use `$ jekyll --server --auto` to see your changes on [localhost:4000](http://localhost:4000) while you develop. Press `ctrl+c` to end. +2. Edit the site using whatever editor you like. When you are satisfied with your change, add your changed files.. + ```bash + $ git add --all + ``` 3. Commit the changes and add a short message explaining what you changed... - - `$ git commit -m 'added a new news post` + ```bash + $ git commit -m "added a new news post" + ``` 4. And publish your changes to Github and the server: - - `$ git push origin` - - `$ git push server` + ```bash + $ git push origin + $ git push server + ``` 5. Your changes will instantly be reflected on http://test.lbrn.lsu.edu!