cerc-io/solidity
10
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 #4964 from ethereum/updateBuilding

Browse Source 
Some updates about how to install solidity.
This commit is contained in:
chriseth 2018-09-17 15:21:38 +02:00 committed by GitHub
commit 40b71cb977
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/installing-solidity.rst
View File

@ -35,13 +35,15 @@ npm / Node.js
============= =============
Use `npm` for a convenient and portable way to install `solcjs`, a Solidity compiler. The Use `npm` for a convenient and portable way to install `solcjs`, a Solidity compiler. The
`solcjs` program has fewer features than all options further down this page. Our `solcjs` program has fewer features than the ways to access the compiler described
further down this page. The
:ref:`commandline-compiler` documentation assumes you are using :ref:`commandline-compiler` documentation assumes you are using
the full-featured compiler, `solc`. So if you install `solcjs` from `npm` then you will the full-featured compiler, `solc`. The usage of `solcjs` is documented inside its own
stop reading the documentation here and then continue to `solc-js <https://github.com/ethereum/solc-js>`_. `repository <https://github.com/ethereum/solc-js>`_.
Note: The solc-js project is derived from the C++ Note: The solc-js project is derived from the C++
`solc` by using Emscripten. `solc-js` can be used in JavaScript projects directly (such as Remix). `solc` by using Emscripten which means that both use the same compiler source code.
`solc-js` can be used in JavaScript projects directly (such as Remix).
Please refer to the solc-js repository for instructions. Please refer to the solc-js repository for instructions.
.. code-block:: bash .. code-block:: bash
@ -50,7 +52,7 @@ Please refer to the solc-js repository for instructions.
.. note:: .. note::
The commandline is named `solcjs`. The commandline executable 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`.
@ -76,7 +78,8 @@ Binary Packages
Binary packages of Solidity are 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, you can get the latest stable
version using the following commands:
.. code-block:: bash .. code-block:: bash
@ -84,7 +87,7 @@ We also have PPAs for Ubuntu. For the latest stable version.
sudo apt-get update sudo apt-get update
sudo apt-get install solc sudo apt-get install solc
If you want to use the cutting edge developer version: The nightly version can be installed using these commands:
.. code-block:: bash .. code-block:: bash
@ -99,7 +102,8 @@ We are also releasing a `snap package <https://snapcraft.io/>`_, which is instal
sudo snap install solc sudo snap install solc
Or if you want to help testing the unstable solc with the most recent changes from the development branch: If you want to help testing the latest development version of Solidity
with the most recent changes, please use the following:
.. code-block:: bash .. code-block:: bash
@ -111,10 +115,9 @@ Arch Linux also has packages, albeit limited to the latest development version:
pacman -S solidity pacman -S solidity
Homebrew is missing pre-built bottles at the time of writing, We distribute the Solidity compiler through Homebrow
following a Jenkins to TravisCI migration, but Homebrew as a build-from-source version. Pre-built bottles are
should still work just fine as a means to build-from-source. currently not supported.
We will re-add the pre-built bottles soon.
.. code-block:: bash .. code-block:: bash
@ -166,7 +169,6 @@ you should fork Solidity and add your personal fork as a second remote:
.. code-block:: bash .. code-block:: bash
cd solidity
git remote add personal git@github.com:[username]/solidity.git git remote add personal git@github.com:[username]/solidity.git
Solidity has git submodules. Ensure they are properly loaded: Solidity has git submodules. Ensure they are properly loaded:
@ -240,9 +242,8 @@ in Visual Studio 2017 Build Tools or Visual Studio 2017:
External Dependencies External Dependencies
--------------------- ---------------------
We now have a "one button" script which installs all required external dependencies We have a helper script which installs all required external dependencies
on macOS, Windows and on numerous Linux distros. This used to be a multi-step on macOS, Windows and on numerous Linux distros.
manual process, but is now a one-liner:
.. code-block:: bash .. code-block:: bash
@ -261,6 +262,8 @@ Command-Line Build
**Be sure to install External Dependencies (see above) before build.** **Be sure to install External Dependencies (see above) before build.**
Solidity project uses CMake to configure the build. Solidity project uses CMake to configure the build.
You might want to install ccache to speed up repeated builds.
CMake will pick it up automatically.
Building Solidity is quite similar on Linux, macOS and other Unices: Building Solidity is quite similar on Linux, macOS and other Unices:
.. code-block:: bash .. code-block:: bash
@ -276,7 +279,7 @@ or even easier:
#note: this will install binaries solc and soltest at usr/local/bin #note: this will install binaries solc and soltest at usr/local/bin
./scripts/build.sh ./scripts/build.sh
And even for Windows: And for Windows:
.. code-block:: bash .. code-block:: bash
@ -329,7 +332,7 @@ The Solidity version string contains four parts:
- the version number - the version number
- pre-release tag, usually set to ``develop.YYYY.MM.DD`` or ``nightly.YYYY.MM.DD`` - pre-release tag, usually set to ``develop.YYYY.MM.DD`` or ``nightly.YYYY.MM.DD``
- commit in the format of ``commit.GITHASH`` - commit in the format of ``commit.GITHASH``
- platform has arbitrary number of items, containing details about the platform and compiler - platform, which has an arbitrary number of items, containing details about the platform and compiler
If there are local modifications, the commit will be postfixed with ``.mod``. If there are local modifications, the commit will be postfixed with ``.mod``.