2020-07-20 05:01:02 +00:00
#+TITLE : The Chronometrist Manual
#+AUTHOR : contrapunctus
2020-07-09 04:43:53 +00:00
The structure of this manual was inspired by https://documentation.divio.com/
2020-07-20 05:01:02 +00:00
* How to...
2020-07-21 06:29:08 +00:00
:PROPERTIES:
:DESCRIPTION: Step-by-step guides to achieve specific tasks
:END:
2020-08-28 05:30:21 +00:00
** How to set up Emacs to contribute
2020-07-20 05:50:49 +00:00
All of these are optional, but recommended for the best experience.
1. Use [[https://github.com/Malabarba/Nameless ][nameless-mode ]] for easier reading of Emacs Lisp code, and
2. Use [[https://github.com/joostkremers/visual-fill-column ][visual-fill-column-mode ]] to soft-wrap lines in Org/Markdown files.
2020-07-09 04:43:53 +00:00
=org-indent-mode= (for Org files) and [[https://elpa.gnu.org/packages/adaptive-wrap.html ][adaptive-prefix-mode ]] (for Markdown and other files) will further enhance the experience.
2020-07-20 05:01:21 +00:00
3. Get the sources from https://github.com/contrapunctus-1/chronometrist and read this manual in the Org format (doc/manual.org), so links to identifiers can take you to their location in the source.
2020-07-20 05:51:02 +00:00
4. Install [[https://github.com/cask/cask ][Cask ]] to easily byte-compile and test the project.
From the project root, you can now run
1. =cask= to install the project dependencies in a sandbox
2. =cask exec buttercup -L . --traceback pretty= to run tests.
2019-10-30 17:02:03 +00:00
2020-07-20 12:00:51 +00:00
# Local Variables:
# org-link-file-path-type: relative
2020-08-28 05:30:39 +00:00
# eval: (progn (make-local-variable (quote after-save-hook)) (add-hook (quote after-save-hook) (lambda () (org-export-to-file 'texinfo "manual.info"))))
2020-07-20 12:00:51 +00:00
# End:
