diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | doc/DEVELOP.md | 47 |
2 files changed, 47 insertions, 1 deletions
@@ -91,6 +91,7 @@ CMakeCache.txt CPackConfig.cmake CPackSourceConfig.cmake CMakeFiles/ +CTestTestfile.cmake _CPack_Packages/ cmake_install.cmake install_manifest.txt diff --git a/doc/DEVELOP.md b/doc/DEVELOP.md index d4e279d4..e3a479d7 100644 --- a/doc/DEVELOP.md +++ b/doc/DEVELOP.md @@ -7,6 +7,9 @@ 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. +[**Cheetah**](http://www.cheetahtemplate.org): a Python templating engine, +used by *./python/server.py*. + [**CMake**](http://www.cmake.org): A cross platform system for building from source code. It uses the *CMakeLists.txt* files. @@ -21,7 +24,11 @@ the *doc/Doxyfile.in* file. 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. +format that produces *html* files from *.md* files. Note that GitHub +automatically renders *.md* files. + +[**sha1**](http://en.wikipedia.org/wiki/SHA-1): a marginally secure +cryptographic hash function, used only for signing the license file. [**Texinfo**](http://www.gnu.org/software/texinfo/): Gnu documentation typesetter that produces *html* and *pdf* files from the *doc/\*.texi* @@ -34,3 +41,41 @@ files. 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. + +[**utfcpp**](http://utfcpp.sourceforge.net): 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 + discription 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 libraries used in development. + +**./lisp/**: the [Emacs](http://www.gnu.org/software/emacs/) + [ledger-mode](http://ledger-cli.org/3.0/doc/ledger-mode.html) lisp code, + under the [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html) license. + +**./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 |