From 49b0a5900dfcda88e24a1fb8a578b273185b28a1 Mon Sep 17 00:00:00 2001 From: Nicolas Kuttler Date: Thu, 12 Feb 2015 23:09:50 +0100 Subject: Add hacking docs --- _articles/2015-02-12-hacking-irssi.org.markdown | 42 +++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 _articles/2015-02-12-hacking-irssi.org.markdown (limited to '_articles/2015-02-12-hacking-irssi.org.markdown') 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 +----- + + +All urls should be prefixed with `{{ "{{" }} site.baseurl {{ }} }}`. -- cgit v1.2.3