status-im
/
nimplay
mirror of https://github.com/status-im/nimplay.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #11 from status-im/readme-fixes 

More up to date README
This commit is contained in:
Jacques Wagener 2019-08-22 23:04:06 +02:00 committed by GitHub
parent 22522c0662 7a830a7f1c
commit af68eb6848
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/installing.md
View File

@ -1,19 +1,30 @@
# Installing
# Installation
To make development of nimplayer easier, NimPlay uses NLVM(https://github.com/arnetheduck/nlvm/tree/master/nlvm).
Which is a LLVM based Nim compiler. To make setup a NimPlay environment, either AppImage (for Linux) or Docker can be used, the minimum requriement for this would be _GNU Make_ and _BASH_.
The NimPlay installation is currently managed through a simple [Makefile](https://github.com/status-im/nimplay/blob/master/Makefile).
To use it, you shouldn't need anything else besides _BASH_, _GNU Make_, _CMake_ and _Python_.
## Using NLVM App
## Obtaining NLVM
To make development of nimplayer easier, NimPlay uses NLVM (https://github.com/arnetheduck/nlvm/tree/master/nlvm) which is a LLVM based Nim compiler. To fetch the latest version of NLVM in either AppImage or Docker form, use one of the following commands:
```
make get-nlvm-appimage
make tools
make examples
```
## Using NLVM docker
or
```
make get-nlvm-docker
```
## Building the examples
This repo includes a number of examples such as the [King of the Hill](https://github.com/status-im/nimplay/blob/master/examples/king_of_the_hill.nim) contract. To build them, use the following commands:
```
git submodule update --init
make get-wabt
make tools
make examples
```