summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCraig Earls <enderw88@gmail.com>2014-04-03 07:05:28 -0700
committerCraig Earls <enderw88@gmail.com>2014-04-03 07:05:28 -0700
commit4537e22eb66998eeacdb8ca99eb1669178e80bf7 (patch)
tree1ea12c0a87177cdf5db7c091c628709d50222fcf
parent8ca2ecd914745647e5d4b1d8a71bffe33146f3d5 (diff)
parentd20d6267b419cd646f8a96b74af3983182c96a72 (diff)
downloadfork-ledger-4537e22eb66998eeacdb8ca99eb1669178e80bf7.tar.gz
fork-ledger-4537e22eb66998eeacdb8ca99eb1669178e80bf7.tar.bz2
fork-ledger-4537e22eb66998eeacdb8ca99eb1669178e80bf7.zip
Merge pull request #269 from merriam/master
DEVELOP.md
-rw-r--r--doc/DEVELOP.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/DEVELOP.md b/doc/DEVELOP.md
new file mode 100644
index 00000000..d4e279d4
--- /dev/null
+++ b/doc/DEVELOP.md
@@ -0,0 +1,36 @@
+GLOSSARY
+----
+
+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.
+
+[**CMake**](http://www.cmake.org): A cross platform system for building
+from source code. It uses the *CMakeLists.txt* files.
+
+[**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.
+
+[**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.