ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-07 03:29:19 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

CORDA-1725 Add documentation on building Corda for Win/*nix and clean up doc bui… (#3578)

Browse Source 
* Add documentation on building Corda for Win/*nix and clean up doc building documentation

* Split up building corda instructions from building docs instructions

* Address review comments
This commit is contained in:
Anthony Keenan 2018-07-13 22:12:20 +01:00 committed by GitHub
parent 208ac49da0
commit a4ad4c7563
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 142 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/source/building-corda.rst Normal file
View File

@ -0,0 +1,56 @@
Building Corda
==============
These instructions are for downloading and building the Corda code locally. If you only wish to develop CorDapps for
use on Corda, you don't need to do this, follow the instructions at :doc:`getting-set-up` and use the precompiled binaries.
Windows
-------
Java
~~~~
1. Visit http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
2. Scroll down to "Java SE Development Kit 8uXXX" (where "XXX" is the latest minor version number)
3. Toggle "Accept License Agreement"
4. Click the download link for jdk-8uXXX-windows-x64.exe (where "XXX" is the latest minor version number)
5. Download and run the executable to install Java (use the default settings)
6. Add Java to the PATH environment variable by following the instructions at https://docs.oracle.com/javase/7/docs/webnotes/install/windows/jdk-installation-windows.html#path
7. Open a new command prompt and run ``java -version`` to test that Java is installed correctly
Git
~~~
1. Visit https://git-scm.com/download/win
2. Click the "64-bit Git for Windows Setup" download link.
3. Download and run the executable to install Git (use the default installation values) and make a note of the installation directory.
4. Open a new command prompt and type ``git --version`` to test that Git is installed correctly
Buillding Corda
~~~~~~~~~~~~~~~
1. Open a command prompt
2. Run ``git clone https://github.com/corda/corda.git``
3. Run ``gradlew build``
Debian/Ubuntu Linux
-------------------
These instructions were tested on Ubuntu Server 18.04 LTS. This distribution includes ``git`` and ``python`` so only the following steps are required:
Java
~~~~
1. Run ``sudo add-apt-repository ppa:webupd8team/java`` from the terminal. Press ENTER when prompted.
2. Run ``sudo apt-get update``
3. Then run ``sudo apt-get install oracle-java8-installer``. Press Y when prompted and agree to the licence terms.
4. Run ``java --version`` to verify that java is installed correctly
Building Corda
~~~~~~~~~~~~~~
1. Open the terminal
2. Run ``git clone https://github.com/corda/corda.git``
3. Run ``./gradlew build``

105
docs/source/building-the-docs.rst
View File

@ -7,44 +7,109 @@ is pre-generated, as well as code documentation, and this can be done automatica
Requirements Requirements
------------ ------------
To build the documentation, you will need: In order to build the documentation you will need a development environment set up as described under :doc:`building-corda`.
* GNU Make You will also need additional dependencies based on your O/S which are detailed below.
* Python and pip (tested with Python 2.7.10)
* Sphinx: http://www.sphinx-doc.org/
* sphinx_rtd_theme: https://github.com/snide/sphinx_rtd_theme
Note that to install under OS X El Capitan, you will need to tell pip to install under ``/usr/local``, which can be Windows
done by specifying the installation target on the command line: -------
.. sourcecode:: shell Git, bash and make
~~~~~~~~~~~~~~~~~~
In order to build the documentation for Corda you need a ``bash`` emulator with ``make`` installed and accessible from the command prompt. Git for
Windows ships with a version of MinGW that contains a ``bash`` emulator, to which you can download and add a Windows port of
``make``, instructions for which are provided below. Alternatively you can install a full version of MinGW from `here <http://www.mingw.org/>`_.
1. Go to `ezwinports <https://sourceforge.net/projects/ezwinports/files/>`_ and click the download for ``make-4.2.1-without-guile-w32-bin.zip``
2. Navigate to the Git installation directory (by default ``C:\Program Files\Git``), open ``mingw64``
3. Unzip the downloaded file into this directory, but do NOT overwrite/replace any existing files
4. Add the Git ``bin`` directory to your system PATH environment variable (by default ``C:\Program Files\Git\bin``)
5. Open a new command prompt and run ``bash`` to test that you can access the Git bash emulator
6. Type ``make`` to make sure it has been installed successfully (you should get an error
like ``make: *** No targets specified and no makefile found. Stop.``)
Python, Pip and VirtualEnv
~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Visit https://www.python.org/downloads
2. Scroll down to the most recent v2 release (tested with v.2.7.15) and click the download link
3. Download the "Windows x86-64 MSI installer"
4. Run the installation, making a note of the Python installation directory (defaults to ``c:\Python27``)
5. Add the Python installation directory (e.g. ``c:\Python27``) to your system PATH environment variable
6. Add the Python scripts sub-directory (e.g. ``c:\Python27\scripts``) to your system PATH environment variable
7. Open a new command prompt and check you can run Python by running ``python --version``
8. Check you can run pip by running ``pip --version``
9. Install ``virtualenv`` by running ``pip install virtualenv`` from the commandline
10. Check you can run ``virualenv`` by running ``virtualenv --version`` from the commandline.
LaTeX
~~~~~
Corda requires LaTeX to be available for building the documentation. The instructions below are for installing TeX Live
but other distributions are available.
1. Visit https://tug.org/texlive/
2. Click download
3. Download and run ``install-tl-windows.exe``
4. Keep the default options (simple installation is fine)
5. Open a new command prompt and check you can run ``pdflatex`` by running ``pdflatex --version``
Debian/Ubuntu Linux
-------------------
These instructions were tested on Ubuntu Server 18.04 LTS. This distribution includes ``git`` and ``python`` so only the following steps are required:
Pip/VirtualEnv
~~~~~~~~~~~~~~
1. Run ``sudo apt-get install python-pip``
2. Run ``pip install virtualenv``
3. Run ``pip --version`` to verify that pip is installed correctly
4. Run ``virtualenv --version`` to verify that virtualenv is installed correctly
LaTeX
~~~~~
Corda requires LaTeX to be available for building the documentation. The instructions below are for installing TeX Live
but other distributions are available.
1. Run ``sudo apt-get install texlive-full``
sudo -H pip install --install-option '--install-data=/usr/local' Sphinx
sudo -H pip install --install-option '--install-data=/usr/local' sphinx_rtd_theme
.. warning:: When installing Sphinx, you may see the following error message: "Found existing installation: six 1.4.1
Cannot uninstall 'six'. It is a distutils installed project and thus we cannot accurately determine which files
belong to it which would lead to only a partial uninstall.". If so, run the install with the
``--ignore-installed six`` flag.
Build Build
----- -----
Once the requirements are installed, you can automatically build the HTML format user documentation and the API Once the requirements are installed, you can automatically build the HTML format user documentation, PDF, and
documentation by running the following script: the API documentation by running the following script:
.. sourcecode:: shell .. sourcecode:: shell
// On Windows
gradlew buildDocs
// On Mac and Linux
./gradlew buildDocs ./gradlew buildDocs
Alternatively you can build non-HTML formats from the ``docs`` folder. Change directory to the folder and then run the Alternatively you can build non-HTML formats from the ``docs`` folder.
following to see a list of all available formats:
However, running ``make`` from the command line requires further dependencies to be installed. When building in Gradle they
are installed in a `python virtualenv <https://virtualenv.pypa.io/en/stable/>`_, so they will need explicitly installing
by running:
.. sourcecode:: shell
pip install -r requirements.txt
Change directory to the ``docs`` folder and then run the following to see a list of all available formats:
.. sourcecode:: shell .. sourcecode:: shell
make make
For example to produce the documentation in HTML format: For example to produce the documentation in HTML format run:
.. sourcecode:: shell .. sourcecode:: shell

1
docs/source/index.rst
View File

@ -84,6 +84,7 @@ We look forward to seeing what you can do with Corda!
:caption: Participate :caption: Participate
:maxdepth: 2 :maxdepth: 2
building-corda.rst
release-process-index.rst release-process-index.rst
corda-repo-layout.rst corda-repo-layout.rst
deterministic-modules.rst deterministic-modules.rst