Contributing to the QCAD User Reference Manual

Discussion forum for contributors and developers who are using the QCAD ECMAScript development platform or the C++ plugin interface or who are otherwise looking to contribute to QCAD (translations, documentation, etc).

Moderator: andrew

Post Reply
User avatar
andrew
Site Admin
Posts: 5694
Joined: Fri Mar 30, 2007 6:07 am

Contributing to the QCAD User Reference Manual

Post by andrew » Thu Sep 21, 2017 10:19 am

The integrated user reference of the QCAD Community Edition is available as part of the QCAD sources at:
https://github.com/qcad/qcad

For example, the English documentation of the line from two points tool can be found at:
https://github.com/qcad/qcad/tree/maste ... Line2P/doc

Line2P_desc_en.html contains a brief description (desc) of the tool in English (en)
Line2P_proc_en.html contains step by step instructions for the procedure (proc) to use the tool in English (en)

The format is simple HTML (without headers, footer). The manual is generated automatically from these files.

If you wish to contribute, please create a github account can then contact me so I can add you to the list of contributors. As a contributor, you can edit these files online or clone and commit / push using git.

Post Reply

Return to “QCAD Developers and Contributors”