Skip to content

Commit 48cdea3

Browse files
committed
Improve doc: section about development
1 parent f83ff48 commit 48cdea3

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,25 @@ $ docker-compose run bintest
9999
* [mruby-eso-research](https://github.com/hone/mruby-eso-research) - an app for managing crafting research in Elder Scrolls Online. It uses YAML as the data store.
100100

101101
## mruby-cli Development
102-
This app is built as a mruby-cli app, so you just need to run: `docker-compose run compile` and find the binaries in the appropriate directories.
102+
103+
### Compile the mruby-cli binaries
104+
105+
This app is built as a `mruby-cli` app. To compile the binaries, you **must** type
106+
107+
```
108+
docker-compose run compile
109+
```
110+
111+
and find the binaries in the appropriate directories (`mruby/build/<target>/bin/`).
112+
113+
The docker container contains the necessary cross toolchain to compile a binary for each supported target. That's why it is checked before running a rake task if it is run inside a container.
114+
115+
Indeed, just using `rake compile` will not work out of the box because the main build is designed to compile on a 64-bit Linux host. It could work if you are on a 64-Linux host and you have an cross toolchain equivalent to the one we provide into the docker container.
116+
117+
This means that if you want to add a new rake task `my_task`, you need to add it to the `docker-compose.yml` to make it available through `docker-compose run my_task`.
118+
119+
### Create the releases
120+
121+
Just type: `rake release`
122+
123+
After this command finishes, you'll see the releases for each target in the `releases` directory.

0 commit comments

Comments
 (0)