kidwellj/findcommonground.uk
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated readme for local clone and test before submitting pull request

Browse source
This commit is contained in:
Holger Reinhardt 2016-01-17 23:22:33 +01:00
parent 122cca3295
commit 49e313342b
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -2,6 +2,8 @@
Pull Requests from our design, development and operations teams of [Haufe.Group](http://www.haufe-lexware.com) and its subsidiaries are greatly appreciated. If you've never contributed to an open source project before we are more than happy to walk you through how to create a pull request.
The short version of it is to simply clone this repo (a) into a repo of your own account with (b) the name `[your_account_name].github.io` and (c) manually change the `url` parameter in `_config.xml` to `http://[your_account_name].github.io`. Commit your changes and a couple of seconds later you should find the blog published on the above configured url. Now you can add your changes and test them live after each commit. **Please do not submit your _config.yml file as part of the pull request.**
Support for Categories and Tags were inspired by [this blog entry](http://www.minddust.com/post/tags-and-categories-on-github-pages/). A list of the defined categories and tags can be found at `_data/categories.yml` and `_data\tags.yml` respectively. If you want to add new categories or tags, you need to add them to the corresponding `.yml` file and add the matching template into the `meta/category` or `meta/tag` directories. Please do not go overboard with adding new categories and tags but try to stay within the ones we have. On the other hand - if you feel strongly about adding one, feel free to submit a pull request.
If you want to find out more about using `github-pages` for blogging or want to improve our blog the following links might be good starting points