conservatory
/
picrin
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,660 Commits 2 Branches 2 Tags 9.9 MiB
Scheme 73.2%
C 22.3%
TeX 3.5%
Shell 0.4%
Makefile 0.4%
Other 0.1%
Go to file
Yuichi Nishiwaki 42cc5042f3 use pic_alloc/pic_free in initializing struct pic_heap 2015-01-22 17:08:41 +09:00
build
…
cmake completely remove git submodule dependency 2015-01-04 04:12:59 +00:00
contrib some procedures are moved to contrib/ 2015-01-18 01:03:29 +09:00
docs update docs 2015-01-17 23:36:17 +09:00
etc update profiling build script 2015-01-18 04:10:57 +00:00
extlib/benz use pic_alloc/pic_free in initializing struct pic_heap 2015-01-22 17:08:41 +09:00
piclib better error messages against invalid use of auxiliary syntax 2015-01-19 06:02:39 +00:00
src restore tuned config 2014-10-27 14:15:03 +09:00
t add regression test against benz/#55 2014-11-09 17:09:06 +09:00
.gitignore update gitignore 2014-07-20 09:46:04 +09:00
.gitmodules rm benz subtree 2015-01-03 06:31:15 +00:00
.travis.yml update travis config 2014-07-18 15:07:41 +09:00
AUTHORS My name was changed 2015-01-04 05:20:33 +00:00
CMakeLists.txt completely remove git submodule dependency 2015-01-04 04:12:59 +00:00
LICENSE wrong years in LICENSE file 2014-05-18 21:38:41 +09:00
README.md add Run Test subsubsection 2015-01-04 04:20:06 +00: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)

Generate Makefile

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

$ cd build
$ cmake ..

Actually you don't necessarily need to move to build directory before running cmake (in that case $ cmake .), 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 cmake.

$ 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

Run Test

To run all the test including contribs, execute this.

$ make test

To test only R7RS features,

$ make test-r7rs

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