Skip to content

Commit 3875d80

Browse files
authored
Merge pull request #12 from mu-editor/readme
Add simple README with some Jekyll installation tips
2 parents ad3e376 + c4cfe75 commit 3875d80

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# codewith.mu
2+
3+
This is the repository that generates the website https://codewith.mu
4+
5+
It uses the GitHub pages functionality to build a Jekyll (a static site generator) project that gets published on each commit on master.
6+
7+
For local development you can follow these instructions to install the toolchain required for Jekyll: https://jekyllrb.com/docs/installation/
8+
9+
Since Jekyll requires Ruby, RubyGems, GCC, Make, and it is not officially supported on Windows, a Vagrant image can be used for simplicity.
10+
Assuming you have Vagrant installed:
11+
12+
```
13+
git clone https://github.com/lcreid/rails-5-jade.git
14+
cd rails-5-jade
15+
vagrant up
16+
vagrant ssh
17+
git clone https://github.com/mu-editor/mu-editor.github.io.git mu-website
18+
cd mu-website
19+
git submodule update --init --recursive
20+
bundle install
21+
jekyll serve --host 0.0.0.0 --force_polling
22+
```
23+
24+
You can then see the output pages at `http://127.0.0.1:4000`

0 commit comments

Comments
 (0)