tuathail
7c3ee6f441
Some clarifications to the Mac OS X install including: Spelled out the home directory (/home/<username>/bin) in step one. Some people might gloss over it and just put it in /bin otherwise. 4 replacements of username are required, not 2. Replaced the ~ with /Users/<username> for consistency, but also if the user switched to root user to avoid it being copied to /var/root/Library.. instead of /Users/<username>/Library...
Syncthing Docs ============== This repo is the source behind http://docs.syncthing.net/. Editing ------- To edit the documentation you need a GitHub account. Once you have created one and logged in, you can edit any page by navigating to the corresponding file and clicking the edit (pen) icon. This will create a so called "fork" and a "pull request", which will be approved by one of the existing documentation team members. Once you have made a contribution or two, you can be added to the documentation team and perform edits without requiring approval. In the long run, learning to use Git_ and running Sphinx_ on your computer is beneficial. Structure --------- The documentation is divided into an index page (``index.rst``) and various subsections. The sections are: - Introductory information in ``intro``. - Information for users in ``users``. - Information for developers in ``dev``. The documentation uses the `rst format`_. For a starting point check out the `reStructuredText Primer`_ .. _Git: http://www.git-scm.com/ .. _Sphinx: http://sphinx-doc.org/ .. _`rst format`: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html .. _`reStructuredText Primer`: http://sphinx-doc.org/rest.html License ======= All documentation and protocol specifications are licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0/>`__.