summaryrefslogtreecommitdiff
path: root/_articles/2015-02-12-hacking-irssi.org.markdown
blob: 1e37e7302e01cd2ac294536b202d2f6e29e4576f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
---
layout: post
title: Hacking irssi.org
author: Nicolas Kuttler
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...
-->
{% raw %}
All urls should be prefixed with `{{ site.baseurl }}`.
{% endraw %}