Skip to content

Commit

Permalink
docs: Updates system setup
Browse files Browse the repository at this point in the history
  • Loading branch information
jrcastro2 committed Dec 10, 2020
1 parent 0f9583a commit faf2694
Showing 1 changed file with 39 additions and 9 deletions.
48 changes: 39 additions & 9 deletions docs/getting-started/development-environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,17 @@ System setup
We support development on macOS and Linux-based systems (development on Windows
is not supported).

macOS
~~~~~
macOS/Linux
~~~~~~~~~~~
We recommend that you install libraries and tools using the
`Homebrew <https://brew.sh>`_ package manager. Homebrew allows you to install
two types of packages - cask and normal.
two types of packages - cask and normal. Cask packages are **only** supported
on **macOS**.

**Cask packages**

Cask packages are usually UI applications that end up in your Applications
folder. You can install cask packages using the command:
folder. You can install cask packages in macOS using the command:

.. code-block:: console
Expand All @@ -48,6 +49,11 @@ Here are some recommended cask packages (only ``docker`` is required):
spectacle # organise windows with keyboard shortcuts
visual-studio-code # a text editor used by many Invenio developers
If you are on Linux you will need to install them using the native package manager.
To install docker and docker-compose in linux you can follow the nice documentation from
`docker <https://docs.docker.com/engine/install/ubuntu/>`_, there you can see the guide
for Ubuntu, but many other distros are supported.

**Normal packages**

Normal packages are usually command line tools/libraries that end up in
Expand All @@ -58,6 +64,20 @@ using the command:
$ brew install <packages>
If you are on linux you can use the native package manager instead of Homebrew.

If using centOS:

.. code-block:: console
$ yum install <packages>
If using Ubuntu:

.. code-block:: console
$ sudo apt-get install <packages>
The following packages are libraries that are likely to be needed during
Invenio development in order to install certain Python packages:

Expand All @@ -80,6 +100,21 @@ Invenio development in order to install certain Python packages:
xz
zlib
In linux distros you need this additional package (to be installed with the
native package manager).

If using CentOS:

.. code-block:: console
$ yum install libffi-devel
If using Ubuntu:

.. code-block:: console
$ sudo apt-get install libffi-dev
Following are CLI tools that are useful during development:

.. code-block:: console
Expand Down Expand Up @@ -175,11 +210,6 @@ See https://docs.docker.com/docker-for-mac/#resources.
A typical sign of needed more resources, is that services are not running or
images are having problems building.

Linux
~~~~~

Want to write it? Contact us on the chat!

Editor
------
You can use any code editor of your choice. Here we give a brief overview of
Expand Down

0 comments on commit faf2694

Please sign in to comment.