Skip to content

Commit 0d85d3d

Browse files
committed
Made changes to the README with instructions about the workflow
1 parent 099f73c commit 0d85d3d

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Note: This page was built using the template provided by the folks from the [Kor
22

33
# SINE lab page
44

5-
This is repository for [SINE lab page](http://sinegit.github.io/). We use Jekyll to run our Github page. We are welcome for other people to contribute to our site not just lab members. Feel free to fork and pull-request!
5+
This is the repository for [SINE lab page](http://sinegit.github.io/). We use Jekyll to run our Github page. We are welcome for other people to contribute to our site not just lab members. Feel free to fork and pull-request!
66

77
## Workflow
88

@@ -21,6 +21,7 @@ bundle install
2121
bundle exec jekyll build
2222
```
2323
This will create the destination directory `_site/` and build the site into it.
24+
2425
4. Add file contents to the index
2526
```bash
2627
git add -A
@@ -40,9 +41,9 @@ The GitHub Pages site will be built from the `master` branch. Thus we need to pu
4041

4142
1. Change the current working directory to the `_site` directory
4243
```bash
43-
cd .side/
44+
cd _site/
4445
```
45-
2. Tell GitHub Pages that there is no need to build (GitHub can build Jekyll site directly from source if it contains only supported plugins. We utilize some unsupported plugins.)
46+
2. Tell GitHub Pages that there is no need to build (GitHub can build Jekyll site directly from the source, the `sources` branch, if it contains only supported plugins. We utilize some unsupported plugins.)
4647
```bash
4748
touch .nojekyll
4849
```
@@ -69,12 +70,10 @@ git push origin master
6970

7071
## Run the page locally using Jekyll
7172

72-
To run locally, follow instruction [here](https://jekyllrb.com/) to install Jekyll then run `jekyll serve` to see in `localhost:4000`. Here is a brief install guidelines.
73+
To run locally:
7374

7475
```bash
75-
sudo gem install jekyll
76-
sudo gem install rouge
77-
jekyll serve
76+
bundle exec jekyll serve
7877
```
7978

8079
## Editing the lab website

0 commit comments

Comments
 (0)