diff options
Diffstat (limited to 'contracts/libs/README.md')
| -rw-r--r-- | contracts/libs/README.md | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/contracts/libs/README.md b/contracts/libs/README.md deleted file mode 100644 index cfa631679..000000000 --- a/contracts/libs/README.md +++ /dev/null @@ -1,70 +0,0 @@ -## Contracts libs - -Smart contracts libs used in the 0x protocol. - -## Usage - -Contracts can be found in the [contracts](./contracts) directory. The contents of this directory are broken down into the following subdirectories: - -- [libs](./contracts/protocol) - - This directory contains the libs. -- [test](./contracts/test) - - This directory contains mocks and other contracts that are used solely for testing contracts within the other directories. - -## Contributing - -We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. - -For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the [0x Improvement Proposals (ZEIPs)](https://github.com/0xProject/ZEIPs) repository and follow the contribution guidelines provided therein. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install Dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/contracts-libs yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/contracts-libs yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` - -#### Testing options - -Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described [here](../TESTING.md). |