aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMu Qiao <qiaomuf@gentoo.org>2011-08-04 15:01:30 +0800
committerMu Qiao <qiaomuf@gentoo.org>2011-08-04 22:15:15 +0800
commitfb007eba7449cf3c7d49530002f7b6706dcb0025 (patch)
treeacd4a0b9d88acb5dd9ba3e8b519d3232ef13d73c
parentBuild: add ABI version (diff)
downloadlibbash-fb007eba7449cf3c7d49530002f7b6706dcb0025.tar.gz
libbash-fb007eba7449cf3c7d49530002f7b6706dcb0025.tar.bz2
libbash-fb007eba7449cf3c7d49530002f7b6706dcb0025.zip
Doc: update README
-rw-r--r--README12
1 files changed, 12 insertions, 0 deletions
diff --git a/README b/README
index 8e00feb..b3ca119 100644
--- a/README
+++ b/README
@@ -25,6 +25,12 @@ bashast/gunit: Grammar gunit tests
src/: source directory for libbash library
src/builtins: source directory for built in bash functionality classes
src/builtins/tests: Unit tests for builtins
+src/core: core runtime for libbash
+src/core/tests: Unit tests for the core runtime
+include/: public headers
+utils/: some utilities that built on libbash
+test/: some general tests for libbash
+scripts/: some bash scripts or ebuilds for testing
coding_standard/: LaTeX coding standard for the project
docs/: output folder for Doxygen generated documentation
@@ -42,3 +48,9 @@ To generate the coding standard from the latex file (with pdflatex):
make coding_standard.pdf
To generate the doxygen documentation:
make doxygen-doc
+To get memory usage statstics of libbash (with Valgrind):
+ make massif
+To get benchmark data for metadata generation (with Valgrind):
+ make benchmark_parser
+To get unit tests coverage:
+ make test_coverage