Add hacking docs

2 files changed, 45 insertions, 0 deletions

diff --git a/_articles/2015-02-12-adding-articles-to-irssi.org.markdown b/_articles/2015-02-12-adding-articles-to-irssi.org.markdown
index ea6664d..ad36fce 100644
--- a/_articles/2015-02-12-adding-articles-to-irssi.org.markdown
+++ b/_articles/2015-02-12-adding-articles-to-irssi.org.markdown
@@ -6,6 +6,9 @@ email: "irssi@kuttler.eu"
 web: "http://kuttler.eu"
 ---
 
+Forking the upstream repository
+==
+
 If you would like to contribute an article to [irssi.org](http://irssi.org)
 fork the [website's github repository](https://github.com/irssi/irssi.github.io)
 and add your article to the `_articles` directory.
diff --git a/_articles/2015-02-12-hacking-irssi.org.markdown b/_articles/2015-02-12-hacking-irssi.org.markdown
new file mode 100644
index 0000000..ae90fd5
--- /dev/null
+++ b/_articles/2015-02-12-hacking-irssi.org.markdown
@@ -0,0 +1,42 @@
+---
+layout: post
+title: "Hacking irssi.org"
+author: "Nicolas Kuttler"
+email: "irssi@kuttler.eu"
+web: "http://kuttler.eu"
+---
+
+Get a local copy
+----------------
+
+If you would like to work on the source code of [irssi.org](http://irssi.org)
+
+1. Fork [the code](https://github.com/irssi/irssi.github.io).
+2. Clone your repository to your local machine.
+3. [Install](http://jekyllrb.com/) jekyll and see their instructions for serving
+   the project.
+4. Have fun!
+
+Make your changes previewable
+-----------------------------
+
+If you want your changes merged it might be a good idea to make them
+previewable. To do this:
+
+1. Create a branch called `gh-pages` with `git checkout -b gh-pages` and
+   `git push origin gh-pages`
+2. In this branch, and in this branch only, edit the `_config.yml` file and
+   modify the `baseurl` setting to `"/irssi.github.io"` (the project name).
+3. Never work on this branch again. But when you create a pull request for
+   your main work branch merge your main work branch into `gh-pages` and push
+   it to github. So it will be possible to preview your changes under
+   `http://username.github.io/irssi.github.io/` which displays your `gh-pages`
+   branch.
+
+Notes
+-----
+
+<!--
+Yeah, it's really weird how liquid renders the curly braces below...
+-->
+All urls should be prefixed with `{{ "{{" }} site.baseurl {{ }} }}`.