Go to file
Yuichi Nishiwaki 527217e94a s/scheme/r7rs/g 2014-09-20 12:22:43 +09:00
build add build dir 2014-03-02 12:58:56 +09:00
cmake add scratch 2014-08-07 16:35:33 +09:00
contrib s/scheme/r7rs/g 2014-09-20 12:22:43 +09:00
docs update benz. (parameterize, object dictionary) 2014-09-15 16:00:19 +09:00
etc add another logo image 2014-09-12 00:05:28 +09:00
extlib update benz 2014-09-20 11:50:07 +09:00
piclib spill out r7rs nitro 2014-09-20 12:21:22 +09:00
src update benz (exception API refactoring) 2014-09-17 00:51:01 +09:00
t import a test case by @SaitoAtsushi 2014-09-10 17:45:18 +09:00
.gitignore update gitignore 2014-07-20 09:46:04 +09:00
.gitmodules delete old submodules 2014-09-01 09:11:45 +09:00
.travis.yml update travis config 2014-07-18 15:07:41 +09:00
AUTHORS add @KeenS to AUTHORS 2014-05-29 01:27:02 +09:00
CMakeLists.txt move main.c to src/ 2014-09-01 09:40:55 +09:00
LICENSE wrong years in LICENSE file 2014-05-18 21:38:41 +09:00
README.md remove features section 2014-09-17 11:20:28 +09:00

README.md

Build Status Docs Status

Picrin is a lightweight scheme implementation intended to comply with full R7RS specification. Its code is written in pure C99 and does not require any special external libraries installed on the platform.

Documentation

See http://picrin.readthedocs.org/

Homepage

Currently picrin is hosted on Github. You can freely send a bug report or pull-request, and fork the repository.

https://github.com/picrin-scheme/picrin

IRC

There is a chat room on chat.freenode.org, channel #picrin. IRC logs here: https://botbot.me/freenode/picrin/

How to use it

To build picrin, you need some build tools installed on your platform.

  • cmake (>= 2.6)
  • git

Because of submodule dependencies, it is necessary to get picrin's source code via git clone command. Basically our git dependencies are only due to submodules, so in fact, If you have no git on your machine, it is possible to build it by downloading a tarball from github page as well. But in such case, you are assumed to modify CMakeLists.txt by yourself to get it work completely. We just strongly recommend you to use git-clone.

Generate Makefile

Change directory to build then run ccmake to create Makefile. Once Makefile is generated you can run make command to build picrin.

$ cd build
$ ccmake ..

Actually you don't necessarily need to move to build directory before running ccmake (in that case $ ccmake .), but I strongly recommend to follow above instruction.

Before generating Makefile, you can change some compilation switches to enable or disable optional features. Take NAN_BOXING for example, when you turn on "Use C11 feature" flag and the platform supports addresses of 48bit length, it is enabled.

Build

A built executable binary will be under bin/ directory and shared libraries under lib/.

$ make

If you are building picrin on other systems than x86_64, PIC_NAN_BOXING flag is automatically turned on (see include/picrin/config.h for detail).

Install

Just running make install, picrin library, headers, and runtime binary are install on your system, by default into /usr/local directory. You can change this value via ccmake.

$ make install

Run

Before installing picrin, you can try picrin without breaking any of your system. Simply directly run the binary bin/picrin from terminal, or you can use make to execute it like this.

$ make run

Debug run

If you execute cmake with debug flag -DCMAKE_BUILD_TYPE=Debug, it builds the binary with all debug flags enabled (PIC_GC_STRESS, VM_DEBUG, DEBUG).

$ cmake -DCMAKE_BUILD_TYPE=Debug ..

Requirement

Picrin scheme depends on some external libraries to build the binary:

  • perl
  • libedit (optional)
  • regex.h of POSIX.1 (optional)

Optional libraries are, if cmake detected them, automatically enabled. The compilation is tested only on Mac OSX and Ubuntu. I think (or hope) it'll be ok to compile and run on other operating systems such as Arch or Windows, but I don't guarantee :(

Authors

See AUTHORS