Skip to content

Commit ccb39e4

Browse files
Merge pull request #305 from lwm/readme-fixups
Readme fixups
2 parents 58a291e + 82e762d commit ccb39e4

File tree

1 file changed

+54
-21
lines changed

1 file changed

+54
-21
lines changed

README.md

Lines changed: 54 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,85 @@ This is the source code for <http://tutorials.codebar.io>
22

33
## Getting started
44

5-
This is a [GitHub Pages](https://pages.github.com/) repo, so you can render the pages with [Jekyll](http://jekyllrb.com/):
5+
This is a [GitHub Pages](https://pages.github.com/) repo, so you can render the pages with [Jekyll](http://jekyllrb.com/).
66

7-
1. `bundle install`, which will install Jekyll
8-
2. `bundle exec jekyll serve`
9-
3. go to http://127.0.0.1:4000
7+
The recommended way of installing the project depdendencies is via [RVM](https://rvm.io/rvm/install).
8+
Follow the [quick installation guide](https://rvm.io/rvm/install#quick-guided-install) and then run:
109

11-
If you also want to make changes to the structure of the site (i.e. if you want to modify the site's Javascript files) and run the tests, first make sure you have a recent version of npm (node) installed. Then do:
10+
```bash
11+
$ rvm install 2.2.1 # inside `codebar/tutorials` folder
12+
$ rvm gemset use codebar-tutorial --create
13+
$ gem install bundler
14+
$ bundle install
15+
```
16+
17+
In order to serve the site, you'll need to have [Node](https://nodejs.org/en/) installed.
18+
This can be done with a tool like [NVM](https://github.com/creationix/nvm). Then run:
19+
20+
```bash
21+
$ jekyll serve # go to http://127.0.0.1:4000
22+
```
23+
24+
If you also want to make changes to the structure of the site (i.e. if you want
25+
to modify the site's Javascript files) and run the tests, you can:
1226

1327
```bash
1428
$ npm install
1529
$ gulp
1630
```
1731

18-
and then go to http://localhost:4000/test/specrunner.html to run the tests. Tests should be green.
32+
Then go to http://localhost:4000/test/specrunner.html to run the tests. Tests should be green.
1933

20-
> *Gulp is only used for development, not in production. In your local copy of this repo, it will concatenate and minify the files inside the `javascripts-dev` folder, as well as watch for changes in that folder. The concatenated and minified JS file will be generated inside the `javascripts` folder. You can push both folders when you are finished with your changes. GitHub pages will then generate the site in production with whatever is inside the `javascripts` folder.*
34+
> *Gulp is only used for development, not in production. In your local copy of
35+
> this repo, it will concatenate and minify the files inside the
36+
> `javascripts-dev` folder, as well as watch for changes in that folder. The
37+
> concatenated and minified JS file will be generated inside the `javascripts`
38+
> folder. You can push both folders when you are finished with your changes.
39+
> GitHub pages will then generate the site in production with whatever is
40+
> inside the `javascripts` folder.*
2141
2242
If you are just updating or adding new tutorials, follow steps 1 to 3 only.
2343

2444
## Getting in Touch
2545

26-
You can go to the general [codebar Slack channel here](https://codebar.slack.com/messages/general/) or the dedicated [tutorials channel here](https://codebar.slack.com/messages/tutorials/). Use it to get in touch and chat to other codebar students/coaches, or if you need help.
46+
You can go to the general [codebar Slack channel here](https://codebar.slack.com/messages/general/) or the
47+
dedicated [tutorials channel here](https://codebar.slack.com/messages/tutorials/). Use it to get in touch
48+
and chat to other codebar students/coaches, or if you need help.
2749

2850
If you are not on Slack use [this link](http://codebar-slack.herokuapp.com/) to get an invite.
2951

3052
## Contributing
3153

32-
We encourage you to contribute with your suggestions and corrections. Head to our [issues page](https://github.com/codebar/tutorials/issues) and open a new issue or help on the existing ones.
54+
We encourage you to contribute with your suggestions and corrections. Head to our
55+
[issues page](https://github.com/codebar/tutorials/issues) and open a new issue or
56+
help on the existing ones.
3357

3458

35-
##### General tutorial rule
59+
##### General tutorial rule
3660

37-
1. All tutorials get the students to build something that they are able to show around at the end of the workshop.
61+
1. All tutorials get the students to build something that they are able to show around at the end of the workshop.
3862

3963
2. All tutorials follow a structure:
4064
* Objectives - "In this tutorial we are going to look at..."
41-
* Goals - "By the end of this tutorial you will have..."
42-
* Then the exercises.
43-
* Bonus - This is not always required but if you feel there is something that could be added then please include it.
44-
* Further reading - Again this is not always required but if you feel there was something in the tutorials that could be covered in more depth then please include any good reading materials/videos or extra tutorials.
45-
46-
3. Repetition is good. A tutorial can contain multiple exercises that ask the students to take similar steps (e.g. for HTTP Requests one exercise introduces GET, another has GET and POST etc).
47-
48-
4. Explaining and getting the students to focus on one new thing at a time, presenting students with lots of new content and usage examples can be confusing.
49-
50-
5. Before starting to write a new tutorial please speak with someone from codebar to see whether it is of interest to students.
65+
* Goals - "By the end of this tutorial you will have..."
66+
* Then the exercises.
67+
* Bonus - This is not always required but if you feel there is
68+
something that could be added then please include it.
69+
* Further reading - Again this is not always required but if you feel
70+
there was something in the tutorials that could be covered in more
71+
depth then please include any good reading materials/videos or extra
72+
tutorials.
73+
74+
3. Repetition is good. A tutorial can contain multiple exercises that ask the
75+
students to take similar steps (e.g. for HTTP Requests one exercise
76+
introduces GET, another has GET and POST etc).
77+
78+
4. Explaining and getting the students to focus on one new thing at a time,
79+
presenting students with lots of new content and usage examples can be
80+
confusing.
81+
82+
5. Before starting to write a new tutorial please speak with someone from
83+
codebar to see whether it is of interest to students.
5184

5285
##### To add downloadable files to a new or existing tutorial:
5386

0 commit comments

Comments
 (0)