File: AUTHORS_README.adoc

package info (click to toggle)
kicad 5.0.2+dfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 234,592 kB
  • sloc: cpp: 505,330; ansic: 57,038; python: 4,886; sh: 879; awk: 294; makefile: 253; xml: 103; perl: 5
file content (39 lines) | stat: -rw-r--r-- 1,183 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
README for doc authors
======================

To start writing a new document, follow these steps:

1) read the README.adoc for the preliminary requirements.

2) create a directory with the same name of the doc title lowercase
with underscore for space.

3) copy a master document from other docs to simplify coherency and
change whatever needs to be changed.

4) follow the convention to call the name of the document with the same
name of the doc project dir

5) if the document is rather large and you want to break it into separate
chapters, follow the convention of calling the chapter files as:

 docname_chapter_name-or-number.adoc

The first _ character will separate the docname from the chapter names
and will guarantee automatic inclusion of the chapters into the final
output formats.

6) when you reach a worthwhile point on your document, create a patch with:

 git add docname
 git commit -m "Added manual docname, first draft"
 git format-patch HEAD^

and send it to the devels or fork with gitbub web interface and ask for
pull merging.

Please, before committing any file, check for functionality, to avoid
breaking automatic compilation of docs.

Happy writing!