diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2bbef1c --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +.PHONY: help lint + +help: ## 📚 Show help for each of the Makefile recipes + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' + +lint: + cargo clippy --workspace --all-targets -- -D warnings diff --git a/README.md b/README.md index f9fdf9d..f6893ee 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ Minimalist, fast and modular implementation of the Lean Ethereum client written in Rust. +## Getting started + +We use `cargo` as our build system. To build and run the client, simply run: + +```sh +cargo run +``` + +Run `make help` or take a look at our [`Makefile`](./Makefile) for other useful commands. + +## Running in a devnet + +To quickly spin up a devnet, see [lean-quickstart](https://github.com/blockblaz/lean-quickstart). + ## Roadmap 0. Initial project setup and integration with [lean-quickstart](https://github.com/blockblaz/lean-quickstart)