/README.md

https://github.com/brigand/ahkbook · Markdown · 40 lines · 30 code · 10 blank · 0 comment · 0 complexity · da384e806f0fa5a03c5d8ca55246d78a MD5 · raw file

  1. # ahkbook - a book on AutoHotkey
  2. Information on this project can be found on its [start page](http://maul-esel.github.com/ahkbook/index.html).
  3. ## Contributing
  4. Please help me with this project. Add your posts, ideas, knowledge, experience to help AutoHotkey beginners, and to provide a reference for advanced users!
  5. To contribute, do the following:
  6. * if you're on github:
  7. * PM me on github or in the AutoHotkey forums
  8. * fork the project
  9. * **IMPORTANT: change the `url` setting in `_config.yml` to `'http://[your username].github.com/ahkbook'`**
  10. * do your changes and additions, optionally creating new branches
  11. * if you have access to a Linux / Ubuntu / ... system or VM, ***consider*** installing Jekyll locally
  12. * test if it works
  13. * send me a pull request when you're done
  14. * otherwise send me your comments, ideas, patches, ... via the AutoHotkey forums or PM me there.
  15. In either way,
  16. * add your posts
  17. * author posts mentioned in the index
  18. * improve and complete existing posts
  19. * translate posts in other languages (place them in a corresponding folder, such as `de/_posts` or `fr/_posts`).
  20. * add yourself to the list of contributors with a website of your choice ;-)
  21. ### Important note:
  22. This project is processed with [Jekyll](https://github.com/mojombo/jekyll#readme). Check it out before contributing.
  23. This doesn't mean you need to install Jekyll, the contents are automatically processed on github. But if you install it, you have (of course) better control about what you push to your github repo.
  24. With Jekyll, you can write your posts in HTML, Markdown (like this file) or Textile.
  25. ### Another important note:
  26. AutoHotkey syntax highlighting via `{% highlight ahk %}` currently doesn't work. I created an issue on Jekyll to address this. If anyone (a Ruby programmer?) knows how to fix this, please do so and send the author a pull request.
  27. Issues:
  28. * [UTF-8](https://github.com/mojombo/jekyll/issues/429) [FIXED!]
  29. * [AHK Syntax](https://github.com/mojombo/jekyll/issues/428)
  30. * [GFM](https://github.com/mojombo/jekyll/issues/427)