Skip to content

Commit

Permalink
move instructions to build to contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andreaTP committed Oct 21, 2024
1 parent 88571a5 commit f425a33
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,19 @@ All submissions, including submissions by project members, need to be reviewed a
* Commits should be atomic and semantic. Please properly squash your pull requests before submitting them. Fixup commits can be used temporarily during the review process but things should be squashed at the end to have meaningful commits.
* We typically squash and merge pull requests when they are approved. This tends to keep the commit history a little bit more tidy without placing undue burden on the developers.

### Building the Runtime

Contributors and other advanced users may want to build the runtime from source. To do so, you'll need to have Maven installed.
`Java version 11+` required for a proper build. You can download and install [Java 11 Temurin](https://adoptium.net/temurin/releases/?version=11)

Basic steps:

* `mvn clean install` to run all of the project's tests and install the library in your local repo
* `mvn -Dquickly` to install the library skipping all tests
* `mvn -Ddev <...goals>` to disable linters and enforcers during development
* `mvn spotless:apply` to autoformat the code
* `./scripts/compile-resources.sh` will recompile and regenerate the `resources/compiled` folders

### Continuous Integration

Because we are all humans, and to ensure Chicory evolves in the right direction, all changes must pass continuous integration before being merged. The CI is based on GitHub Actions, which means that pull requests will receive automatic feedback. Please watch out for the results of these workflows to see if your PR passes all tests.
Expand Down
15 changes: 0 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,18 +106,3 @@ as interpreting bytecode can only be so fast.
* [asmble](https://github.com/cretz/asmble)
* [kwasm](https://github.com/jasonwyatt/KWasm)
* [wazero](https://wazero.io/)

### Building the Runtime

Contributors and other advanced users may want to build the runtime from source. To do so, you'll need to have Maven installed.
`Java version 11+` required for a proper build. You can download and install [Java 11 Temurin](https://adoptium.net/temurin/releases/?version=11)

Basic steps:

* `mvn clean install` to run all of the project's tests and install the library in your local repo
* `mvn -Dquickly` to install the library skipping all tests
* `mvn -Ddev <...goals>` to disable linters and enforcers during development
* `mvn spotless:apply` to autoformat the code
* `./scripts/compile-resources.sh` will recompile and regenerate the `resources/compiled` folders

NOTE: The `install` target relies on the `wabt` library to compile the test suite. This is not currently released for ARM (e.g. new Macs with Apple Silicon). However, `wabt` is available from Homebrew, so `brew install wabt` before running `mvn clean install` should work.

0 comments on commit f425a33

Please sign in to comment.