Skip to content

Commit 099f73c

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

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

+63
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,69 @@ Note: This page was built using the template provided by the folks from the [Kor
44

55
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!
66

7+
## Workflow
8+
9+
### Maintaining the `sources` branch
10+
11+
1. Clone the `sources` branch of this repository
12+
```bash
13+
git clone -b sources https://github.com/sinegit/sinegit.github.io.git
14+
```
15+
2. Install the dependencies specified in the Gemfile
16+
```bash
17+
bundle install
18+
```
19+
3. Build the website
20+
```bash
21+
bundle exec jekyll build
22+
```
23+
This will create the destination directory `_site/` and build the site into it.
24+
4. Add file contents to the index
25+
```bash
26+
git add -A
27+
```
28+
5. Commit the changes
29+
```bash
30+
git commit -m "Your message"
31+
```
32+
6. Push the commit to the `sources` branch
33+
```bash
34+
git push origin sources
35+
```
36+
37+
### Maintaining the `master` branch
38+
39+
The GitHub Pages site will be built from the `master` branch. Thus we need to push the `_site` folder to the `master` branch
40+
41+
1. Change the current working directory to the `_site` directory
42+
```bash
43+
cd .side/
44+
```
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+
```bash
47+
touch .nojekyll
48+
```
49+
3. Add our repository
50+
```bash
51+
git remote add origin https://github.com/sinegit/sinegit.github.io.git
52+
```
53+
4. Switch to the `master` branch
54+
```bash
55+
git checkout -b master
56+
```
57+
5. Add file contents to the index
58+
```bash
59+
git add -A
60+
```
61+
6. Commit the changes
62+
```bash
63+
git commit -m "Your message"
64+
```
65+
7. Push the commit to the `master` branch
66+
```bash
67+
git push origin master
68+
```
69+
770
## Run the page locally using Jekyll
871

972
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.

0 commit comments

Comments
 (0)