Emacs config utilizing prelude as a base
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

54 lines
1.8 KiB

  1. ## Issues
  2. Report issues and suggest features and improvements on the
  3. [GitHub issue tracker](https://github.com/bbatsov/prelude/issues). Don't ask
  4. questions on the issue tracker - use the [support channels](support.md) instead.
  5. If you want to file a bug, please provide all the necessary info listed in
  6. our issue reporting template (it's loaded automatically when you create a
  7. new GitHub issue).
  8. ## Patches
  9. Patches in any form are always welcome! GitHub pull requests are even better! :-)
  10. Before submitting a patch or a pull request make sure that your patch
  11. is in line with the [contribution
  12. guidelines](https://github.com/bbatsov/prelude/blob/master/CONTRIBUTING.md).
  13. ## Documentation
  14. Good documentation is just as important as good code.
  15. Consider improving and extending the
  16. this manual and the
  17. [community wiki](https://github.com/bbatsov/prelude/wiki).
  18. ### Working on the Manual
  19. The manual is generated from the markdown files in the
  20. [doc](https://github.com/bbatsov/prelude/tree/master/doc) folder of Prelude's
  21. GitHub repo and is published to [Read the Docs](readthedocs.org). The
  22. [MkDocs](http://www.mkdocs.org/) tool is used to convert the markdown sources to
  23. HTML.
  24. To make changes to the manual you simply have to change the files under
  25. `doc`. The manual will be regenerated automatically when changes to those files
  26. are merged in `master` (or the latest stable branch).
  27. You can install `MkDocs` locally and use the command `mkdocs serve` to see the
  28. result of changes you make to the manual locally:
  29. ```sh
  30. $ cd path/to/prelude/repo
  31. $ mkdocs serve
  32. ```
  33. If you want to make changes to the manual's page structure you'll have to edit
  34. [mkdocs.yml](https://github.com/bbatsov/prelude/blob/master/mkdocs.yml).
  35. ## Donations
  36. You can support the development of Prelude via
  37. [PayPal](https://www.paypal.me/bbatsov) and
  38. [Patreon](https://www.patreon.com/bbatsov).