From 5fa2f5147b90292bb46bd232f463736df0d3d089 Mon Sep 17 00:00:00 2001 From: Andrea Peruffo Date: Fri, 18 Oct 2024 18:26:22 +0100 Subject: [PATCH] move instructions to build to contributing.md --- CONTRIBUTING.md | 13 +++++++++++++ README.md | 15 --------------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 736405f97..3f685d802 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 443ee22d2..249dabde7 100644 --- a/README.md +++ b/README.md @@ -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.