cerc-io/solidity
15
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #3381 from fulldecent/patch-3

Browse Source 
No nonsense explanation of compiler options
This commit is contained in:
chriseth 2018-01-11 16:44:36 +01:00 committed by GitHub
commit 0c20b6da6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/installing-solidity.rst
View File

@ -2,9 +2,9 @@
.. _installing-solidity: .. _installing-solidity:
################### ################################
Installing Solidity Installing the Solidity Compiler
################### ################################
Versioning Versioning
========== ==========
@ -18,30 +18,38 @@ will use the latest release.
Remix Remix
===== =====
If you just want to try Solidity for small contracts, you *We recommend Remix for small contracts and for quickly learning Solidity.*
can try `Remix <https://remix.ethereum.org/>`_
which does not need any installation. If you want to use it `Access Remix online <https://remix.ethereum.org/>`_, you don't need to install anything.
without connection to the Internet, you can go to If you want to use it without connection to the Internet, go to
https://github.com/ethereum/browser-solidity/tree/gh-pages and https://github.com/ethereum/browser-solidity/tree/gh-pages and download the .ZIP file as
download the .ZIP file as explained on that page. explained on that page.
Further options on this page detail installing commandline Solidity compiler software
on your computer. Choose a commandline compiler if you are working on a larger contract
or if you require more compilation options.
npm / Node.js npm / Node.js
============= =============
This is probably the most portable and most convenient way to install Solidity locally. Use `npm` for a convenient and portable way to install `solcjs`, a Solidity compiler. The
`solcjs` program has less features than all options further down this page. Our
`Using the compiler <using-the-compiler.html>` documentation assumes you are using
the full-featured compiler, `solc`. So if you install `solcjs` from `npm` then you will
stop reading the documentation here and then continue to <https://github.com/ethereum/solc-js>,
A platform-independent JavaScript library is provided by compiling the C++ source Note: The `solc-js <https://github.com/ethereum/solc-js>` project is derived from the C++
into JavaScript using Emscripten. It can be used in projects directly (such as Remix). `solc` by using Emscripten. `solc-js` can be used in JavaScript projects directly (such as Remix).
Please refer to the `solc-js <https://github.com/ethereum/solc-js>`_ repository for instructions. Please refer to the `solc-js <https://github.com/ethereum/solc-js>`_ repository for instructions.
It also contains a commandline tool called `solcjs`, which can be installed via npm:
.. code:: bash .. code:: bash
npm install -g solc npm install -g solc
.. note:: .. note::
The commandline is named `solcjs`.
The comandline options of `solcjs` are not compatible with `solc` and tools (such as `geth`) 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`. expecting the behaviour of `solc` will not work with `solcjs`.
@ -63,7 +71,7 @@ output directories.
Binary Packages Binary Packages
=============== ===============
Binary packages of Solidity available at Binary packages of Solidity are available at
`solidity/releases <https://github.com/ethereum/solidity/releases>`_. `solidity/releases <https://github.com/ethereum/solidity/releases>`_.
We also have PPAs for Ubuntu. For the latest stable version. We also have PPAs for Ubuntu. For the latest stable version.