Skip to content

Commit bad5d14

Browse files
committed
Updated README
Added information about how to translate the tutorial. Added a first-timers-only badge.
1 parent 1491383 commit bad5d14

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Regex-Tutorial
22
==============
33

44
[![Build Status](https://travis-ci.org/CoderDojoPotsdam/regex-tutorial.svg?branch=master)](https://travis-ci.org/CoderDojoPotsdam/regex-tutorial)
5-
[![First Timers](https://firsttimers.quelltext.eu/repository/coderdojopotsdam/regex-tutorial.svg)](https://firsttimers.quelltext.eu/repository/coderdojopotsdam/regex-tutorial.html)
5+
[![first-timers-only Friendly](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/)
66

77
This is the source code for the [Regular Expressions Interactive Tutorial][site].
88

@@ -13,12 +13,25 @@ Please use the tutorial.
1313
If you have something to add or find a mistake, there is a link on each page to edit and improve the HTML file.
1414
Then you can make a [pull request][pr].
1515

16+
Translate
17+
-------
18+
19+
Do you want to translate the tutorial into your own language? Great!
20+
To do that, start by creating translations of the strings in [localization.json](https://github.com/CoderDojoPotsdam/regex-tutorial/blob/master/_data/localization.json).
21+
Then you can create a folder in the root directory for your language and start translating!
22+
When you have translated the first file, make sure to link to it in the [index file](https://github.com/CoderDojoPotsdam/regex-tutorial/blob/master/index.html).
23+
1624
Setup
1725
-----
1826

19-
To setup a development enviroment `gem install jekyll`
20-
Then run `jekyll serve --trace`
21-
Type in `localhost:4000`
27+
There are two ways to run this website, either by downloading Jekyll on your computer or by using GitHub Pages.
28+
29+
### Install Jekyll
30+
31+
1. Launch a terminal and run `gem install jekyll` to install Jekyll
32+
2. Then run `jekyll serve --trace` in your forked repository to run Jekyll from there.
33+
3. Type in `localhost:4000` to visit the website.
34+
You can read more about installing Jekyll [here](https://jekyllrb.com/docs/installation/).
2235

2336
### Github Pages
2437
1. [Fork](https://github.com/CoderDojoPotsdam/regex-tutorial/fork)
@@ -36,7 +49,7 @@ License
3649
<span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/InteractiveResource" property="dct:title" rel="dct:type">Regex-Tutorial</span> by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">Nicco Kunzmann</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License.</a>.
3750

3851

39-
Images in the "extern" folder are under a separate license.
52+
Images in the [img](https://github.com/CoderDojoPotsdam/regex-tutorial/tree/master/img) folder are under a separate license.
4053

4154

4255
[site]: https://coderdojopotsdam.github.io/regex-tutorial

0 commit comments

Comments
 (0)