aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/utils/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-12-04 21:41:18 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-12-04 21:41:18 +0800
commite8d0aff333c33ead5da0878fa776aa0f42abd567 (patch)
tree28dc73fd2e3b524cb2a32465d88ad30cfb6799d4 /contracts/utils/README.md
parent79f5e36edbd8a4483aac46032092dece95bb0b4c (diff)
downloaddexon-0x-contracts-e8d0aff333c33ead5da0878fa776aa0f42abd567.tar.gz
dexon-0x-contracts-e8d0aff333c33ead5da0878fa776aa0f42abd567.tar.zst
dexon-0x-contracts-e8d0aff333c33ead5da0878fa776aa0f42abd567.zip
Refactor @0x/contracts-utils from @0x/contracts-core
Diffstat (limited to 'contracts/utils/README.md')
-rw-r--r--contracts/utils/README.md70
1 files changed, 70 insertions, 0 deletions
diff --git a/contracts/utils/README.md b/contracts/utils/README.md
new file mode 100644
index 000000000..e7c7b49ff
--- /dev/null
+++ b/contracts/utils/README.md
@@ -0,0 +1,70 @@
+## Contracts utils
+
+Smart contracts utils 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:
+
+* [utils](./contracts/utils)
+ * This directory contains libraries and utils.
+* [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-utils yarn build
+```
+
+Or continuously rebuild on change:
+
+```bash
+PKG=@0x/contracts-utils 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).