summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCharles Merriam <charles.merriam@gmail.com>2014-04-02 10:07:56 -0700
committerCharles Merriam <charles.merriam@gmail.com>2014-04-02 10:07:56 -0700
commitd20d6267b419cd646f8a96b74af3983182c96a72 (patch)
treec237454323cff093a2a4f64361e27334049a9104 /doc
parent5653458af21105424e0bf51267124141c75a78d0 (diff)
downloadfork-ledger-d20d6267b419cd646f8a96b74af3983182c96a72.tar.gz
fork-ledger-d20d6267b419cd646f8a96b74af3983182c96a72.tar.bz2
fork-ledger-d20d6267b419cd646f8a96b74af3983182c96a72.zip
More developer terms
Mention a few more tools used. Also word-wrap, which touched most lines.
Diffstat (limited to 'doc')
-rw-r--r--doc/DEVELOP.md38
1 files changed, 29 insertions, 9 deletions
diff --git a/doc/DEVELOP.md b/doc/DEVELOP.md
index a1d20ed7..d4e279d4 100644
--- a/doc/DEVELOP.md
+++ b/doc/DEVELOP.md
@@ -1,16 +1,36 @@
GLOSSARY
----
-Developing the Ledger software uses a number different tools, not all of which will be familiar to all developers.
+Developing the Ledger software uses a number different tools, not all of
+which will be familiar to all developers.
-[**Boost**](http://www.boost.org): a standard set of C++ libraries. Most Boost libraries consist of inline functions and templates in header files.
+[**Boost**](http://www.boost.org): a standard set of C++ libraries. Most
+Boost libraries consist of inline functions and templates in header files.
-[**GCC**](http://gcc.gnu.org): GNU Compiler Collection, which includes gcc (the compiler) and gcov (coverage and line based performance) tools.
+[**CMake**](http://www.cmake.org): A cross platform system for building
+from source code. It uses the *CMakeLists.txt* files.
-[**GMP**](https://gmplib.org): Gnu Multiple Precision Arithmetic Library provides arbitrary precision math.
+[**DOxygen**](http://doxygen.org): generates programming documentation from
+source code files. Primarly used on C++ sources, but works on all. Uses
+the *doc/Doxyfile.in* file.
-[**Travis CI**](https://travis-ci.org): a hosted continuous integration service that
- builds and runs tests each commit posted to GitHub. Each build creates
- a [log](https://travis-ci.org/ledger/ledger), updates a [small graphic](https://travis-ci.org/ledger/ledger.png?branch=master) at the top left of
- the main project's
- [README.md](https://github.com/ledger/ledger/blob/master/README.md), and emails the author of the commit if any tests fail.
+[**GCC**](http://gcc.gnu.org): Gnu Compiler Collection, which includes the
+*gcc* compiler and *gcov* coverage/profiler tool.
+
+[**GMP**](https://gmplib.org): Gnu Multiple Precision Arithmetic Library
+provides arbitrary precision math.
+
+[**Markdown**](https://daringfireball.net/projects/markdown/): A typesetter
+format that produces *html* files from *\*.md* files. Note that GitHub automatically renders *.md* files.
+
+[**Texinfo**](http://www.gnu.org/software/texinfo/): Gnu documentation
+typesetter that produces *html* and *pdf* files from the *doc/\*.texi*
+files.
+
+[**Travis CI**](https://travis-ci.org): a hosted continuous integration
+ service that builds and runs tests each commit posted to GitHub. Each
+ build creates a [log](https://travis-ci.org/ledger/ledger), updates a
+ [small graphic](https://travis-ci.org/ledger/ledger.png?branch=master) at
+ the top left of the main project's
+ [README.md](https://github.com/ledger/ledger/blob/master/README.md), and
+ emails the author of the commit if any tests fail.