Difference between revisions of "Google Season of Docs/Project Ideas"
From BRL-CAD
(stub three major documentation projects) |
|||
| Line 1: | Line 1: | ||
| − | If you want to work on '''computer-aided design (CAD), geometry, or graphics''' documentation, you've come to the right place! Help us improve open source CAD. | + | If you want to work on '''computer-aided design (CAD), geometry, or graphics''' documentation, you've come to the right place! Help us improve open source BRL-CAD. |
| − | + | Get started quickly by: | |
| + | # [https://brlcad.org/wiki/Compiling Compiling BRL-CAD from source] | ||
| + | # [https://brlcad.org/wiki/Documentation Reading our existing docs] | ||
| + | # [https://brlcad.org/wiki/Main_page Getting some additional doc perspective] | ||
| + | # [http://brlcad.org/HACKING_BRL-CAD.pdf Reading our contributor guide] | ||
| − | Remember that project descriptions are just '' | + | Well prepared proposals from capable technical writers have a good chance of getting selected. We consider proposals for all skill levels ranging from simple to crazy hard and everything in between. [https://brlcad.zulipchat.com Introduce yourself via chat] (preferred) or [mailto:devs@brlcad.org via e-mail], and we'll help you plan a project right for you. |
| + | |||
| + | Remember that project descriptions are just ''rough ideas''. You must expand with [[Summer_of_Code/Application_Guidelines|considerably more detail]]. Change the goals to fit your experience and interests. | ||
Revision as of 04:08, 22 April 2019
If you want to work on computer-aided design (CAD), geometry, or graphics documentation, you've come to the right place! Help us improve open source BRL-CAD.
Get started quickly by:
- Compiling BRL-CAD from source
- Reading our existing docs
- Getting some additional doc perspective
- Reading our contributor guide
Well prepared proposals from capable technical writers have a good chance of getting selected. We consider proposals for all skill levels ranging from simple to crazy hard and everything in between. Introduce yourself via chat (preferred) or via e-mail, and we'll help you plan a project right for you.
Remember that project descriptions are just rough ideas. You must expand with considerably more detail. Change the goals to fit your experience and interests.
| Technologies | Difficulty | Contacts | |
|---|---|---|---|
| Write an Introduction to BRL-CAD: TBD. | Docbook XML | Easy | morrison, rossberg |
| Organize all existing BRL-CAD documentation: TBD. | Mediawiki, Docbook XML, Subversion | Medium | morrison, rossberg |
| Write a BRL-CAD Primitives manual: TBD. | Docbook XML, Subversion, C/C++ | Hard | morrison, rossberg |
