mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
Updated Solidity documentation's "building from source" section.
It now references install_deps.sh/.bat, and also adds instructions for Windows. Cherry picked some further tweaks from Denton-L. Thanks :-)
This commit is contained in:
Bob Summerwill
parent
9fc1bcb2be
commit
d49cfebbf7
@ -32,102 +32,119 @@ Details about the usage of the Node.js package can be found in the
|
||||
Binary Packages
|
||||
===============
|
||||
|
||||
Binary packages of Solidity together with its IDE Mix are available through
|
||||
the `C++ bundle <https://github.com/ethereum/webthree-umbrella/releases>`_ of
|
||||
Ethereum.
|
||||
Binary packages of Solidity available at
|
||||
`solidity/releases <https://github.com/ethereum/solidity/releases>`_.
|
||||
|
||||
|
||||
Building from Source
|
||||
====================
|
||||
|
||||
Building Solidity is quite similar on MacOS X, Ubuntu and probably other Unices.
|
||||
This guide starts explaining how to install the dependencies for each platform
|
||||
and then shows how to build Solidity itself.
|
||||
Clone the Repository
|
||||
--------------------
|
||||
|
||||
MacOS X
|
||||
-------
|
||||
To clone the source code, execute the following command:
|
||||
|
||||
|
||||
Requirements:
|
||||
|
||||
- OS X Yosemite (10.10.5)
|
||||
- Homebrew
|
||||
- Xcode
|
||||
|
||||
Set up Homebrew:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
brew update
|
||||
brew upgrade
|
||||
|
||||
brew install boost --c++11 # this takes a while
|
||||
brew install cmake cryptopp gmp jsoncpp
|
||||
|
||||
Ubuntu Trusty (14.04)
|
||||
---------------------
|
||||
|
||||
Below are the instructions to install the minimal dependencies required
|
||||
to compile Solidity on Ubuntu 14.04 (Trusty Tahr).
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt-get -y install build-essential git cmake libgmp-dev libboost-all-dev \
|
||||
libjsoncpp-dev
|
||||
|
||||
sudo add-apt-repository -y ppa:ethereum/ethereum
|
||||
sudo add-apt-repository -y ppa:ethereum/ethereum-dev
|
||||
sudo apt-get -y update
|
||||
sudo apt-get -y upgrade # this will update cmake to version 3.x
|
||||
sudo apt-get -y install libcryptopp-dev libjsoncpp-dev
|
||||
|
||||
Ubuntu Xenial (16.04)
|
||||
---------------------
|
||||
|
||||
Below are the instructions to install the minimal dependencies required
|
||||
to compile Solidity on Ubuntu 16.04 (Xenial Xerus).
|
||||
|
||||
One of the dependencies (Crypto++ Library, with version >= 5.6.2) can be
|
||||
installed either by adding the Ethereum PPA (Option 1) or by backporting
|
||||
``libcrypto++`` from Ubuntu Development to Ubuntu Xenial (Option 2).
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt-get -y install build-essential git cmake libgmp-dev libboost-all-dev \
|
||||
libjsoncpp-dev
|
||||
|
||||
# (Option 1) For those willing to add the Ethereum PPA:
|
||||
sudo add-apt-repository -y ppa:ethereum/ethereum
|
||||
sudo add-apt-repository -y ppa:ethereum/ethereum-dev
|
||||
sudo apt-get -y update
|
||||
sudo apt-get -y upgrade
|
||||
sudo apt-get -y install libcryptopp-dev
|
||||
|
||||
## (Option 2) For those willing to backport libcrypto++:
|
||||
#sudo apt-get -y install ubuntu-dev-tools
|
||||
#sudo pbuilder create
|
||||
#mkdir ubuntu
|
||||
#cd ubuntu
|
||||
#backportpackage --workdir=. --build --dont-sign libcrypto++
|
||||
#sudo dpkg -i buildresult/libcrypto++6_*.deb buildresult/libcrypto++-dev_*.deb
|
||||
#cd ..
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
Run this if you plan on installing Solidity only:
|
||||
|
||||
.. code-block:: bash
|
||||
.. code:: bash
|
||||
|
||||
git clone --recursive https://github.com/ethereum/solidity.git
|
||||
cd solidity
|
||||
mkdir build
|
||||
cd build
|
||||
cmake .. && make
|
||||
|
||||
If you want to help developing Solidity,
|
||||
you should fork Solidity and add your personal fork as a second remote:
|
||||
|
||||
.. code-block:: bash
|
||||
.. code:: bash
|
||||
|
||||
cd solidity
|
||||
git remote add personal git@github.com:username/solidity.git
|
||||
git remote add personal git@github.com:[username]/solidity.git
|
||||
|
||||
|
||||
Prerequisites - macOS
|
||||
----------------------
|
||||
|
||||
For macOS, ensure that you have the latest version of
|
||||
`xcode installed <https://developer.apple.com/xcode/download/>`_.
|
||||
This contains the `Clang C++ compiler <https://en.wikipedia.org/wiki/Clang>`_, the
|
||||
`xcode IDE <https://en.wikipedia.org/wiki/Xcode>`_ and other Apple development
|
||||
tools which are required for building C++ applications on OS X.
|
||||
If you are installing xcode for the first time, or have just installed a new
|
||||
version then you will need to agree to the license before you can do
|
||||
command-line builds:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo xcodebuild -license accept
|
||||
|
||||
Our OS X builds require you to `install the Homebrew <http://brew.sh>`_
|
||||
package manager for installing external dependencies.
|
||||
Here's how to `uninstall Homebrew
|
||||
<https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/FAQ.md#how-do-i-uninstall-homebrew>`_,
|
||||
if you ever want to start again from scratch.
|
||||
|
||||
|
||||
Prerequisites - Windows
|
||||
------------------------
|
||||
|
||||
You will need to install the following dependencies for Windows builds of Solidity:
|
||||
|
||||
+------------------------------+-------------------------------------------------------+
|
||||
| Software | Notes |
|
||||
+==============================+=======================================================+
|
||||
| `Git for Windows`_ | Command-line tool for retrieving source from Github. |
|
||||
+------------------------------+-------------------------------------------------------+
|
||||
| `CMake`_ | Cross-platform build file generator. |
|
||||
+------------------------------+-------------------------------------------------------+
|
||||
| `Visual Studio 2015`_ | C++ compiler and dev environment. |
|
||||
+------------------------------+-------------------------------------------------------+
|
||||
|
||||
.. _Git for Windows: https://git-scm.com/download/win
|
||||
.. _CMake: https://cmake.org/download/
|
||||
.. _Visual Studio 2015: https://www.visualstudio.com/products/vs-2015-product-editions
|
||||
|
||||
|
||||
External Dependencies
|
||||
---------------------
|
||||
|
||||
We now have a "one button" script which installs all required external dependencies
|
||||
on macOS, Windows and on numerous Linux distros. This used to be a multi-step
|
||||
manual process, but is now a one-liner:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
./scripts/install_deps.sh
|
||||
|
||||
Or, on Windows:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
scripts\install_deps.bat
|
||||
|
||||
|
||||
Command-Line Build
|
||||
------------------
|
||||
|
||||
Building Solidity is quite similar on Linux, macOS and other Unices:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
cmake .. && make
|
||||
|
||||
And even on Windows:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
cmake -G "Visual Studio 14 2015 Win64" ..
|
||||
|
||||
This latter set of instructions should result in the creation of
|
||||
**solidity.sln** in that build directory. Double-clicking on that file
|
||||
should result in Visual Studio firing up. We suggest building
|
||||
**RelWithDebugInfo** configuration, but all others work.
|
||||
|
||||
Alternatively, you can build for Windows on the command-line, like so:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
cmake --build . --config RelWithDebInfo
|
||||
|
||||
Loading…
Reference in New Issue
Block a user