diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5dc7fe4 --- /dev/null +++ b/Makefile @@ -0,0 +1,11 @@ +tests: + bin/test.sh + +build: + bin/build.sh + +dependencies: + # foundry + curl -L https://foundry.paradigm.xyz | bash + # jq + sudo apt install jq diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..87c1a12 --- /dev/null +++ b/Readme.md @@ -0,0 +1,19 @@ +# Dexorder contract + +Dexorder Solidity code is in this subproject. This readme is for running contract code standalone for testing purposes. + +## Quickstart + +```bash +# install dependencies: foundry, jq, make +curl -L https://foundry.paradigm.xyz | bash +sudo apt install jq +sudo apt install make + +# build and test the contract +make +``` + +## Development + +The development environment is based on [Foundry](https://book.getfoundry.sh) toolset.