emileclarkb/hammer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Meredith L. Patterson 2013-11-26 16:27:28 -08:00
parent bf67809ab9
commit 63e984d643
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -18,8 +18,8 @@ Features
* Regular expressions * Regular expressions
* Language bindings: * Language bindings:
* C++ (not yet implemented) * C++ (not yet implemented)
* Java * Java (not currently building; give us a few days)
* Python (not yet implemented) * Python
* Ruby (not yet implemented) * Ruby (not yet implemented)
* Perl (not yet implemented) * Perl (not yet implemented)
* Go (not yet implemented) * Go (not yet implemented)
@ -39,7 +39,9 @@ Installing
To build, type `scons`. To run the built-in test suite, type `scons test`. For a debug build, add `--variant=debug` To build, type `scons`. To run the built-in test suite, type `scons test`. For a debug build, add `--variant=debug`
If jni.h and jni_md.h aren't already somewhere on your include path, prepend To build bindings, pass a "bindings" argument to scons, e.g. `scons bindings=python`. `scons bindings=python test` will build Python bindings and run tests for both C and Python. `--variant=debug` is valid here too.
For Java, if jni.h and jni_md.h aren't already somewhere on your include path, prepend
`C_INCLUDE_PATH=/path/to/jdk/include` to that. `C_INCLUDE_PATH=/path/to/jdk/include` to that.
To make Hammer available system-wide, use `scons install`. This places include files in `/usr/local/include/hammer` To make Hammer available system-wide, use `scons install`. This places include files in `/usr/local/include/hammer`
@ -48,7 +50,9 @@ and library files in `/usr/local/lib` by default; to install elsewhere, add a `p
Usage Usage
===== =====
Just `#include <hammer/hammer.h>` and link with `-lhammer`. Just `#include <hammer/hammer.h>` (also `#include <hammer/glue.h>` if you plan to use any of the convenience macros) and link with `-lhammer`.
If you've installed Hammer system-wide, you can use `pkg-config` in the usual way.
Examples Examples
======== ========