aboutsummaryrefslogtreecommitdiffstats
path: root/packages/monorepo-scripts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-12-20 09:37:14 +0800
committerFabio Berger <me@fabioberger.com>2017-12-20 09:37:14 +0800
commit5d240222093dafd9c9d2db24e66668b4214c1b8e (patch)
tree2cdb42137840545cd4f995b2ee393a0d9d86fa20 /packages/monorepo-scripts
parentc75eaca5b676d42e1c0ada765a7ff8369c728ff9 (diff)
downloaddexon-sol-tools-5d240222093dafd9c9d2db24e66668b4214c1b8e.tar
dexon-sol-tools-5d240222093dafd9c9d2db24e66668b4214c1b8e.tar.gz
dexon-sol-tools-5d240222093dafd9c9d2db24e66668b4214c1b8e.tar.bz2
dexon-sol-tools-5d240222093dafd9c9d2db24e66668b4214c1b8e.tar.lz
dexon-sol-tools-5d240222093dafd9c9d2db24e66668b4214c1b8e.tar.xz
dexon-sol-tools-5d240222093dafd9c9d2db24e66668b4214c1b8e.tar.zst
dexon-sol-tools-5d240222093dafd9c9d2db24e66668b4214c1b8e.zip
Add mono repo scripts README
Diffstat (limited to 'packages/monorepo-scripts')
-rw-r--r--packages/monorepo-scripts/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/packages/monorepo-scripts/README.md b/packages/monorepo-scripts/README.md
new file mode 100644
index 000000000..d2299b70d
--- /dev/null
+++ b/packages/monorepo-scripts/README.md
@@ -0,0 +1,51 @@
+Mono repo scripts
+------
+
+This repository contains a few helpful scripts for working with this mono repo.
+
+## Usage
+
+#### Dependency versions
+In order to reduce the size of this repo, we try and use the same versions of dependencies between packages. To make it easier to discover version discrepancies between packages, you can run:
+
+```bash
+yarn deps_versions
+```
+
+This will list out any dependencies that differ in versions between packages.
+
+## Contributing
+
+We strongly recommend the community to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
+
+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
+
+```bash
+yarn build
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```