aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2017-02-02 19:27:55 +0800
committerGitHub <noreply@github.com>2017-02-02 19:27:55 +0800
commitd85d0393cd0fdaedf4b9c065f3efbdf6435583a7 (patch)
treeee81d3d0456df3c3ea3c2d3d5b1decf98cd1aaf2
parentb3b82c46e71a664becbc5051199e12d4687c1fea (diff)
parent821314aa270fe8b83a05d0b68fefe80fdeeef76c (diff)
downloaddexon-solidity-d85d0393cd0fdaedf4b9c065f3efbdf6435583a7.tar
dexon-solidity-d85d0393cd0fdaedf4b9c065f3efbdf6435583a7.tar.gz
dexon-solidity-d85d0393cd0fdaedf4b9c065f3efbdf6435583a7.tar.bz2
dexon-solidity-d85d0393cd0fdaedf4b9c065f3efbdf6435583a7.tar.lz
dexon-solidity-d85d0393cd0fdaedf4b9c065f3efbdf6435583a7.tar.xz
dexon-solidity-d85d0393cd0fdaedf4b9c065f3efbdf6435583a7.tar.zst
dexon-solidity-d85d0393cd0fdaedf4b9c065f3efbdf6435583a7.zip
Merge pull request #1636 from ethereum/docs-solcjs
Explain the difference between solc and solcjs
-rw-r--r--docs/installing-solidity.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst
index 345780d7..66e8038f 100644
--- a/docs/installing-solidity.rst
+++ b/docs/installing-solidity.rst
@@ -25,24 +25,25 @@ without connection to the Internet, you can go to
https://github.com/ethereum/browser-solidity/tree/gh-pages and
download the .ZIP file as explained on that page.
-
npm / Node.js
=============
This is probably the most portable and most convenient way to install Solidity locally.
A platform-independent JavaScript library is provided by compiling the C++ source
-into JavaScript using Emscripten for browser-solidity and there is also an npm
-package available.
+into JavaScript using Emscripten. It can be used in projects directly (such as Browser-Solidity).
+Please refer to the `solc-js <https://github.com/ethereum/solc-js>`_ repository for instructions.
-To install it, simply use
+It also contains a commandline tool called `solcjs`, which can be installed via npm:
.. code:: bash
- npm install solc
+ npm install -g solc
+
+.. note::
-Details about the usage of the Node.js package can be found in the
-`solc-js repository <https://github.com/ethereum/solc-js>`_.
+ The comandline options of `solcjs` are not compatible with `solc` and tools (such as `geth`)
+ expecting the behaviour of `solc` will not work with `solcjs`.
Docker
======