contrapunctus
/
chronometrist
Archived
1
3
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity
This repository has been archived on 2022-05-13. You can view files and clone it, but cannot push or open issues or pull requests.
chronometrist/doc/manual.org

1.4 KiB
Raw Blame History

The Chronometrist Manual

The structure of this manual was inspired by https://documentation.divio.com/

How to…

How to set up Emacs to contribute

All of these are optional, but recommended for the best experience.

  1. Use nameless-mode for easier reading of Emacs Lisp code, and
  2. Use visual-fill-column-mode to soft-wrap lines in Org/Markdown files. org-indent-mode (for Org files) and adaptive-prefix-mode (for Markdown and other files) will further enhance the experience.
  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.

  4. Install 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.