From 098e9bdb43718258b3d0dd935b26d0aa2a742922 Mon Sep 17 00:00:00 2001 From: Yuichi Nishiwaki Date: Fri, 29 Nov 2013 00:15:10 +0900 Subject: [PATCH] update README --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5050b641..0c20ab1b 100644 --- a/README.md +++ b/README.md @@ -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.