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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
Tips for contributors
---------------------
* Please **make pull requests against `next`, not `master`**.
Ledger follows a [git-flow] branching model,
in which development happens on the `next` branch and is subsequently merged into `master` for releases.
* If you're making **changes to files for which the Travis build is not
relevant**, please **add `[ci skip]` to the end of the commit message**.
GLOSSARY
----
Developing the Ledger software uses a number different tools, not all of
which will be familiar to all developers.
**[Boost]**: a standard set of C++ libraries. Most
Boost libraries consist of inline functions and templates in header files.
**[Boost.Python]**: C++ library which enables seamless interoperability
between C++ and the Python programming language.
**[Cheetah]**: a Python templating engine, used by `./python/server.py`.
**[CMake]**: A cross platform system for building from source code. It uses
the `CMakeLists.txt` files.
**[Doxygen]**: generates programming documentation from
source code files. Primarily used on C++ sources, but works on all. Uses
the `doc/Doxyfile.in` file.
**[GCC]**: Gnu Compiler Collection, which includes the
*gcc* compiler and *gcov* coverage/profiler tool.
**[clang]**: C language family frontend for LLVM, which
includes the *clang* compiler.
**[GMP]**: Gnu Multiple Precision Arithmetic Library
provides arbitrary precision math.
**[MPFR]**: Gnu Multiple Precision Floating-point Library
with correct rounding.
**[Markdown]**: A typesetter
format that produces *html* files from *.md* files. Note that GitHub
automatically renders *.md* files.
**[SHA1]**: a marginally secure cryptographic hash function, used only for
signing the license file.
**[Texinfo]**: Gnu documentation
typesetter that produces *html* and *pdf* files from the `doc/\*.texi` files.
**[Travis CI]**: a hosted continuous integration
service that builds and runs tests each commit posted to GitHub. Each
build creates a [log], updates a [small badge] at
the top left of the main project's
[README.md], and
emails the author of the commit if any tests fail.
**[utfcpp]**: a library for handling utf-8 in a variety of C++ versions.
Orientation
---
The source tree can be confusing to a new developer. Here is a selective
orientation:
**./acprep**: a custom thousand-line script to install dependencies, grab
updates, and build. It also creates `\*.cmake`,
`./CmakeFiles/` and other CMake temporary files. Use `./acprep --help`
for more information.
**./README.md**: user readme file in markdown format, also used as the project
description on GitHub.
**./contrib/**: contributed scripts of random quality and completion. They
usually require editing to run.
**./doc/**: documentation, licenses, and
tools for generating documents such as the *pdf* manual.
**./lib/**: a couple of libraries used in development.
**./python/**: samples using the Python ledger module.
**./src/**: the C++ header and source files in a flat directory.
**./test/**: a testing harness with subdirectories full of tests
**./tools/**: an accretion of tools, mostly small scripts, to aid development
[Boost]: http://boost.org
[Boost.Python]: http://www.boost.org/libs/python/
[GMP]: http://gmplib.org/
[MPFR]: http://www.mpfr.org/
[Cheetah]: http://www.cheetahtemplate.org
[CMake]: http://www.cmake.org
[Doxygen]: http://doxygen.org
[Markdown]: https://daringfireball.net/projects/markdown/
[SHA1]: http://en.wikipedia.org/wiki/SHA-1
[Texinfo]: http://www.gnu.org/software/texinfo/
[Travis CI]: https://travis-ci.org
[GCC]: http://gcc.gnu.org
[utfcpp]: http://utfcpp.sourceforge.net
[log]: https://travis-ci.org/ledger/ledger
[small badge]: https://img.shields.io/travis/ledger/ledger/master.svg?&style=flat
[git-flow]: http://nvie.com/posts/a-successful-git-branching-model/
[README.md]: https://github.com/ledger/ledger/blob/master/README.md
[clang]: http://clang.llvm.org
|
