diff options
| author | Johannes Stoelp <johannes.stoelp@gmail.com> | 2023-12-08 00:49:28 +0100 |
|---|---|---|
| committer | Johannes Stoelp <johannes.stoelp@gmail.com> | 2023-12-08 00:53:19 +0100 |
| commit | b5aea3fb5fcce31599e3d7397d5413a934132231 (patch) | |
| tree | 3cc276b4a42d8864ede5283bc2c51eeaafff1228 /README.md | |
| parent | d233e44b04da45dcc99980662db6d3776d9f4a10 (diff) | |
| download | juicebox-asm-b5aea3fb5fcce31599e3d7397d5413a934132231.tar.gz juicebox-asm-b5aea3fb5fcce31599e3d7397d5413a934132231.zip | |
ci: introduce Makefile
Add CI checks into ci/Makefile and update gh actions.
Motivation is, that makefile can also be added as pre-commit hook for
local development:
> echo 'make -C ci' > .git/hooks/pre-commit; chmod +x .git/hooks/pre-commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -58,5 +58,13 @@ The [`examples/`](examples/) folder provides additional examples: - [`add.rs`](examples/add.rs) jit compile a function calling another function compiled into the example. - [`tiny_vm.rs`](examples/tiny_vm.rs) define a minimal `virtual machine (VM)` which demonstrates a simple jit compiler for translating VM guest software. +## git hook for local development + +The [`ci/`] checks can be run automatically during local development by +installing the following `pre-commit` git hook. +```sh +echo 'make -C ci' > .git/hooks/pre-commit; chmod +x .git/hooks/pre-commit +``` + ## License This project is licensed under the [MIT](LICENSE) license. |