diff options
author | Hsuan Lee <boczeratul@gmail.com> | 2019-03-06 17:46:50 +0800 |
---|---|---|
committer | Hsuan Lee <boczeratul@gmail.com> | 2019-03-06 17:46:50 +0800 |
commit | 35703539d0f2b4ddb3b11d0de8c9634af59ab71f (patch) | |
tree | ae3731221dbbb3a6fa40060a8d916cfd3f738289 /packages/sol-compiler/README.md | |
parent | 92a1fde5b1ecd81b07cdb5bf0c9c1cd3544799db (diff) | |
download | dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.gz dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.bz2 dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.lz dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.xz dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.zst dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.zip |
Deploy @dexon-foundation/0x.jsstable
Diffstat (limited to 'packages/sol-compiler/README.md')
-rw-r--r-- | packages/sol-compiler/README.md | 97 |
1 files changed, 0 insertions, 97 deletions
diff --git a/packages/sol-compiler/README.md b/packages/sol-compiler/README.md deleted file mode 100644 index 412a5fc02..000000000 --- a/packages/sol-compiler/README.md +++ /dev/null @@ -1,97 +0,0 @@ -## @0x/sol-compiler - -Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds: - -- Smart re-compilation: Only recompiles when smart contracts have changed -- Ability to compile an entire project instead of only individual `.sol` files -- Compilation using the Solidity version specified at the top of each individual `.sol` file -- Proper parsing of Solidity version ranges -- Support for the standard [input description](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#input-description) for what information you'd like added to the resulting `artifacts` file (i.e 100% configurable artifacts content). - -### Read the [Documentation](https://0xproject.com/docs/sol-compiler). - -## Installation - -#### CLI Installation - -```bash -yarn global add @0x/sol-compiler -``` - -#### API Installation - -```bash -yarn add @0x/sol-compiler -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -**Import** - -```typescript -import { Compiler } from '@0x/sol-compiler'; -``` - -or - -```javascript -var Compiler = require('@0x/sol-compiler').Compiler; -``` - -## Contributing - -We welcome improvements and fixes from the wider community! 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 - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/sol-compiler yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/sol-compiler yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` |