aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/sol-compiler/introduction.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-05-08 21:42:07 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-05-10 23:47:38 +0800
commita6f72de09d7b2c9738b78d2097baa9906838fbe9 (patch)
tree17126a5b45dabf2c7410d25668c68ce3d78284f0 /packages/website/md/docs/sol-compiler/introduction.md
parent96037aed5231aa9344e5037aa6cff3d01f4abdae (diff)
downloaddexon-sol-tools-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar
dexon-sol-tools-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.gz
dexon-sol-tools-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.bz2
dexon-sol-tools-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.lz
dexon-sol-tools-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.xz
dexon-sol-tools-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.zst
dexon-sol-tools-a6f72de09d7b2c9738b78d2097baa9906838fbe9.zip
Rename deployer to sol-compiler
Diffstat (limited to 'packages/website/md/docs/sol-compiler/introduction.md')
-rw-r--r--packages/website/md/docs/sol-compiler/introduction.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/packages/website/md/docs/sol-compiler/introduction.md b/packages/website/md/docs/sol-compiler/introduction.md
new file mode 100644
index 000000000..aa1939006
--- /dev/null
+++ b/packages/website/md/docs/sol-compiler/introduction.md
@@ -0,0 +1,13 @@
+Welcome to the [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler) documentation! Sol-compiler is a tool for compiling Solidity smart contracts and generating artifacts with ease.
+
+It serves a similar purpose as parts of the [Truffle framework](http://truffleframework.com/), but with the UNIX philosophy in mind: Make each program do one thing well. This tool is for intermediate to advanced Solidity developers that require greater configurability and reliability.
+
+Sol-compiler has the following advantages over Truffle:
+
+* Compile each smart contract with a specific version of Solidity.
+* Improved artifact files:
+ * Storage of constructor args, source maps and paths to all requisite source files.
+ * An easy to maintain codebase: TypeScript + Single repo.
+ * Supports Solidity version ranges - contract compiled with latest Solidity version that satisfies the range.
+
+Sol-compiler can be used as a command-line tool or as an imported module.