Skip to content

Updated README #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2017
Merged

Updated README #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Regex-Tutorial
==============

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

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

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

Translate
-------

Do you want to translate the tutorial into your own language? Great!
To do that, start by creating translations of the strings in [localization.json](https://github.com/CoderDojoPotsdam/regex-tutorial/blob/master/_data/localization.json).
Then you can create a folder in the root directory for your language and start translating!
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).

Setup
-----

To setup a development enviroment `gem install jekyll`
Then run `jekyll serve --trace`
Type in `localhost:4000`
There are two ways to run this website, either by downloading Jekyll on your computer or by using GitHub Pages.

### Install Jekyll

1. Launch a terminal and run `gem install jekyll` to install Jekyll
2. Then run `jekyll serve --trace` in your forked repository to run Jekyll from there.
3. Type in `localhost:4000` to visit the website.
You can read more about installing Jekyll [here](https://jekyllrb.com/docs/installation/).

### Github Pages
1. [Fork](https://github.com/CoderDojoPotsdam/regex-tutorial/fork)
Expand All @@ -36,7 +49,7 @@ License
<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>.


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


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