Skip to content

Commit

Permalink
Add Ubuntu environment setup instructions to docs/getting-set-up (cor…
Browse files Browse the repository at this point in the history
…da#3608)

* remove network simulator references in docs

* Added environment setup instructions for Ubuntu

* Revert "Upstream merge"

This reverts commit db4920f, reversing
changes made to 208ac49.

* Address review comments
  • Loading branch information
Sphar-io authored and Anthony Keenan committed Jul 20, 2018
1 parent fe9b893 commit cad684f
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ see changes to this list.
* Johann Palychata (BNP Paribas)
* johnnyychiu
* Jonathan Sartin (R3)
* Jonathan Sphar (R3)
* Jose Coll (R3)
* Jose Luu (Natixis)
* Josh Lindl (BCS)
Expand Down
36 changes: 34 additions & 2 deletions docs/source/getting-set-up.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,14 @@ The set-up instructions are available for the following platforms:

* :ref:`mac-label` (or `in video form <https://vimeo.com/217462230>`__)

* :ref:`deb-ubuntu-label`

.. _windows-label:

Windows
-------

.. warning:: If you are using a Mac machine, please follow the :ref:`mac-label` instructions instead.
.. warning:: If you are using a Mac or a Debian/Ubuntu machine, please follow the :ref:`mac-label` or :ref:`deb-ubuntu-label` instructions instead.

Java
^^^^
Expand Down Expand Up @@ -78,7 +80,7 @@ IntelliJ
Mac
---

.. warning:: If you are using a Windows machine, please follow the :ref:`windows-label` instructions instead.
.. warning:: If you are using a Windows or a Debian/Ubuntu machine, please follow the :ref:`windows-label` or :ref:`deb-ubuntu-label` instructions instead.

Java
^^^^
Expand All @@ -95,6 +97,36 @@ IntelliJ
2. Download and run the executable to install IntelliJ Community Edition (use the default settings)
3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version|

.. _deb-ubuntu-label:

Debian/Ubuntu
------

.. warning:: If you are using a Mac or a Windows machine, please follow the :ref:`mac-label` or :ref:`windows-label` instructions instead.

These instructions were tested on Ubuntu Desktop 18.04 LTS.

Java
^^^^
1. Open a new terminal and add the Oracle PPA to your repositories by typing ``sudo add-apt-repository ppa:webupd8team/java``. Press ENTER when prompted.
2. Update your packages list with the command ``sudo apt update``
3. Install the Oracle JDK 8 by typing ``sudo apt install oracle-java8-installer``. Press Y when prompted and agree to the licence terms.
4. Verify that the JDK was installed correctly by running ``java -version``

Git
^^^^
1. From the terminal, Git can be installed using apt with the command ``sudo apt install git``
2. Verify that git was installed correctly by typing ``git --version``

IntelliJ
^^^^^^^^
Jetbrains offers a pre-built snap package that allows for easy, one-step installation of IntelliJ onto Ubuntu.

1. To download the snap, navigate to https://snapcraft.io/intellij-idea-community
2. Click ``Install``, then ``View in Desktop Store``. Choose ``Ubuntu Software`` in the Launch Application window.
3. Ensure the Kotlin plugin in Intellij is updated to version |kotlin_version|


Next steps
----------
First, run the :doc:`example CorDapp <tutorial-cordapp>`.
Expand Down

0 comments on commit cad684f

Please sign in to comment.