sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More terms and orientation

Browse source 
Added Cheetah, sha1, utfcpp and  finished the orientation section.
This commit is contained in:
Charles Merriam 2014-04-04 09:54:28 -07:00
parent 09e09521ce
commit db916c9a69
1 changed files with 28 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
doc/DEVELOP.md
View file

@ -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*
@ -35,6 +42,9 @@ files.
[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
---
@ -50,7 +60,22 @@ orientation:
**./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.
**./contrib/**: contributed scripts of random quality and completion. They
usually require editing to run.
**./doc**: documentation, licenses, and
**./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