Skip to content

Commit

Permalink
doc: update INSTALL.md for external deps
Browse files Browse the repository at this point in the history
  • Loading branch information
Reini Urban committed Jun 10, 2013
1 parent d2ae4f6 commit c3634a6
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 4 deletions.
41 changes: 40 additions & 1 deletion INSTALL.md
Expand Up @@ -19,12 +19,50 @@ Lastly, to verify your build
## ~ the latest potion ~

To build the bleeding edge, you will need
GNU make, binutils and gcc or clang.
GNU make, binutils, perl, sed, and gcc or clang.

$ git clone --branch master git://github.com/perl11/potion.git
$ cd potion
$ make

## ~ external dependencies ~

build-time: gnu make, perl, sed, gcc or clang, echo, cat, expr, git
(perl is only needed because of BSD/darwin sed problems)

run-time:
libuv, sregex, libtommath are included, but external packagers
should choose to use existing packages. see dist.mak

optional:

libudis on x86 (debugging only)
http://udis86.sourceforge.net/ x86 16,32,64 bit
port install udis86

libdistorm64 on x86 (debugging only)
http://ragestorm.net/distorm/ x86 16,32,64 bit with all intel/amd extensions
apt-get install libdistorm64-dev

libdisasm on i386 (debugging only)
http://bastard.sourceforge.net/libdisasm.html 386 32bit only
apt-get install libdisasm-dev

sloccount (for make sloc)
apt-get install sloccount

redcloth (for make doc install)
apt-get install ruby-redcloth, or
port install rb-redcloth

doxygen 1.8 or 1.9 (for make doc install)
apt-get install doxygen, or
port install doxygen

GNU global (for make docall install)
apt-get install global, or
port install global

## ~ installing ~

$ sudo make install
Expand Down Expand Up @@ -53,6 +91,7 @@ On Ubuntu, if you have MinGW installed,
This will first create a native greg and core/syntax.c,
sets CROSS=1 and cross-compile with the given CC.
See tools/mk-release.sh

make test will not work, you need to copy a make dist tarball
to the machine and test it there.

Expand Down
7 changes: 4 additions & 3 deletions doc/core-files.txt
Expand Up @@ -13,16 +13,17 @@
| khash.h | a hashtable library, modified to suit potion's gc |
| lick.c | the interleaved data format |
| mt19937ar.c | C-program for MT19937, with initialization |
| number.c | simple math |
| number.c | arithmetic on NUM and DECIMAL |
| objmodel.c | much of this is based on the work of ian piumarta |
| potion.c | the Potion! |
| potion.c | the Potion! frontend |
| primitive.c | methods for the primitive types |
| string.c | internals of utf-8 and byte strings |
| syntax.c | A recursive-descent parser generated by greg 0.3.0 |
| syntax.g | Potion tokens and grammar |
| syntax.y | Potion tokens and grammar |
| table.c | the central table type, based on khash |
| vm-ppc.c | the powerpc jit (32-bit only) |
| vm-x86.c | the x86 and x86_64 jit |
| vm-dis.c | the jit disassembler for -DJ |
| vm.c | the vm execution loop |
|-------------+----------------------------------------------------|

0 comments on commit c3634a6

Please sign in to comment.