Documentation

Author: Randall Munroe[1], CC BY-NC 2.5 license.

We have a Github repository[2] for OpenPlotter documentation. This repository is connected to a Gitbook book[3] and we coordinate editors in a forum[4] on OpenMarine.

if you want to help us to write, update, correct or translate you have two options.

You are familiar with Github and Gitbook repositories edition:

  • Create an account in Github[5]
  • Send your Github account user name to the forum[4] and wait for you to be granted permissions to edit the repository.
  • From the sticky threads in the forum[4], select a chapter marked in blue and notify your intentions in a new thread.
  • Once you have permissions, login to Gitbook[6] with your Github account.
  • Go to the book[3] and click on the Edit button upper right.

You are not familiar with Github and Gitbook repositories edition:

  • From the sticky threads in the forum[4], select a chapter marked in blue and notify your intentions in a new thread.
  • When you are done, publish text and images into a new thread in the forum[4] and someone will edit the book for you.

Writing

We write the documentation source in English to make easier translating to other languages.

Please do not modify the index or the structure without consulting developers. Once a chapter is done, please notify on the forum[4] to be marked in green.

To include images in the rest of languages from English folder, the path is ../en/xxx.png

If you want to add images of wiring and connections consider using fritzing[7] application.

Do not modify or translate files names (xxx.md xxx.png xxx.jpg ...) because they are referenced in the text.


[1] https://xkcd.com [2] https://github.com/sailoog/openplotter-documentation [3] https://www.gitbook.com/book/sailoog/openplotter-documentation/details [4] http://forum.openmarine.net/forumdisplay.php?fid=16 [5] https://github.com/join [6] https://www.gitbook.com/login [7] http://fritzing.org

results matching ""

    No results matching ""