aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/sol-compiler/1/introduction.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/website/md/docs/sol-compiler/1/introduction.md')
-rw-r--r--packages/website/md/docs/sol-compiler/1/introduction.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/packages/website/md/docs/sol-compiler/1/introduction.md b/packages/website/md/docs/sol-compiler/1/introduction.md
new file mode 100644
index 000000000..fcd80f47b
--- /dev/null
+++ b/packages/website/md/docs/sol-compiler/1/introduction.md
@@ -0,0 +1,8 @@
+Welcome to the [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler) documentation! 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).
+* Storage of constructor args, source maps and paths to all dependency source files.