From 038949d4305b6b25711e85450c15990e1035574a Mon Sep 17 00:00:00 2001 From: Kenneth Heafield Date: Sat, 19 Jan 2013 12:41:37 +0000 Subject: [PATCH] Documentation improvements --- BUILDING | 2 +- Jamroot | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 10 +--------- 3 files changed, 51 insertions(+), 10 deletions(-) diff --git a/BUILDING b/BUILDING index b2bf953c7..6bdd0aae0 100644 --- a/BUILDING +++ b/BUILDING @@ -3,7 +3,7 @@ If you have Boost >= 1.36.0 installed: ./bjam install --prefix=/usr #optional If you only want the query code: - ./compile.sh + ./compile_query_only.sh Windows: The windows directory has visual studio files. Note that you need to compile diff --git a/Jamroot b/Jamroot index a297b31ac..7760f6f39 100644 --- a/Jamroot +++ b/Jamroot @@ -1,3 +1,52 @@ +#BUILDING KENLM +# +#DEPENDENCIES +#Remember that some distributions split packages into development and binary +#versions. You need the development versions. +# +#zlib and Boost >= 1.36.0 are required. Don't have Boost? You can compile the +#queries part with ./compile_query_only.sh . +#--with=boost=/path/to/boost uses a Boost install from a custom path. +# +#The following optional packages are autodetected: +#libtcmalloc_minimal from google-perftools +#bzip2 +#lzma aka xz +# +#INSTALLATION +#--prefix=/path/to/prefix sets the install prefix [default is source root]. +#--bindir=/path/to/prefix/bin sets the bin directory [PREFIX/bin] +#--libdir=/path/to/prefix/lib sets the lib directory [PREFIX/lib] +#--includedir=/path/to/prefix/include installs headers. +# Does not install if missing. No argument defaults to PREFIX/include . +#--install-scripts=/path/to/scripts copies scripts into a directory. +# Does not install if missing. No argument defaults to PREFIX/scripts . +#--git appends the git revision to the prefix directory. +# +#BUILD OPTIONS +# By default, the build is multi-threaded, optimized, and statically linked. +# Pass these to change the build: +# +# threading=single|multi controls threading (default multi) +# +# variant=release|debug|profile builds optimized (default), for debug, or for +# profiling +# +# link=static|shared controls preferred linking (default static) +# --static forces static linking (the default will fall +# back to shared) +# +# debug-symbols=on|off include or exclude (default) debugging +# information also known as -g +# --without-libsegfault does not link with libSegFault +# +# --max-kenlm-order maximum ngram order that kenlm can process (default 6) +# +#CONTROLLING THE BUILD +#-a to build from scratch +#-j$NCPUS to compile in parallel +#--clean to clean + path-constant TOP : . ; include $(TOP)/jam-files/sanity.jam ; diff --git a/README.md b/README.md index 11befb4ba..0c6ee17db 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,7 @@ I do development in master on https://github.com/kpu/kenlm/. Normally, it works The website http://kheafield.com/code/kenlm/ has more documentation. If you're a decoder developer, please download the latest version from there instead of copying from another decoder. ## Compiling - -For estimating and filtering, you need Boost >= 1.36.0 (and preferably newer). Compile with -```bash -./bjam -``` -If you don't have boost and only need the query code, compile with -```bash -./compile_query_only.sh -``` +See BUILDING. ## Estimation lmplz estimates unpruned language models with modified Kneser-Ney smoothing. After compiling with bjam, run