conservatory
/
picrin
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

This commit is contained in:
Yuichi Nishiwaki 2013-11-29 00:15:10 +09:00
parent 5577cbb128
commit 098e9bdb43
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -86,18 +86,12 @@ https://github.com/wasabiz/picrin
## 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
$ make build
built executable binary will be under bin/ directory and shared library `libpicrin.so` under lib/.
A built executable binary will be under bin/ directory and a shared library `libpicrin.so` under lib/.
$ make
If you want to build picrin on other systems than x86_64, make sure PIC_NAN_BOXING flag is turned off (see include/config.h for detail).
- run
@ -106,8 +100,12 @@ https://github.com/wasabiz/picrin
$ make run
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).
- debug-run
When `make` command is called with an argument `debug`, it builds the binary with all debug flags enabled (PIC_GC_STRESS, VM_DEBUG, DEBUG).
$ make debug
- install
As of now picrin does not provide a command automatically installs the binary. If you want to place picrin library and binary in a parmanent directory, please do it by hand.