update README

This commit is contained in:
Yuichi Nishiwaki 2013-11-15 16:16:34 +09:00
parent 2b570edd52
commit b834fb9ca3
1 changed files with 8 additions and 6 deletions

View File

@ -86,24 +86,26 @@ https://github.com/wasabiz/picrin
## How to use it ## How to use it
- debug-run
By default make command runs REPL with all debug flags enabled (PIC_GC_STRESS, VM_DEBUG, DEBUG).
$ make
- build - build
$ make build $ make build
built executable binary will be under bin/ directory and shared library `libpicrin.so` under lib/. built executable binary will be under bin/ directory and shared library `libpicrin.so` under lib/.
If you want to build picrin on other systems than x86_64, make sure PIC_NAN_BOXING flag is turned off (see include/picconf.h for detail).
- run - run
Simply directly run the binary `bin/picrin` from terminal, or you can use `make` to execute it like this. Simply directly run the binary `bin/picrin` from terminal, or you can use `make` to execute it like this.
$ make run $ make run
- debug-run
By default make command runs REPL with all debug flags enabled.
$ make
In the default option, when `make` command is called without arguments, it builds the binary and right after that dropped into the picrin interactive shell (REPL). In the default option, when `make` command is called without arguments, it builds the binary and right after that dropped into the picrin interactive shell (REPL).
- install - install