Skip to content

Commit faf2694

Browse files
committed
docs: Updates system setup
1 parent 0f9583a commit faf2694

File tree

1 file changed

+39
-9
lines changed

1 file changed

+39
-9
lines changed

docs/getting-started/development-environment.rst

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,17 @@ System setup
2020
We support development on macOS and Linux-based systems (development on Windows
2121
is not supported).
2222

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

2930
**Cask packages**
3031

3132
Cask packages are usually UI applications that end up in your Applications
32-
folder. You can install cask packages using the command:
33+
folder. You can install cask packages in macOS using the command:
3334

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

5359
Normal packages are usually command line tools/libraries that end up in
@@ -58,6 +64,20 @@ using the command:
5864
5965
$ brew install <packages>
6066
67+
If you are on linux you can use the native package manager instead of Homebrew.
68+
69+
If using centOS:
70+
71+
.. code-block:: console
72+
73+
$ yum install <packages>
74+
75+
If using Ubuntu:
76+
77+
.. code-block:: console
78+
79+
$ sudo apt-get install <packages>
80+
6181
The following packages are libraries that are likely to be needed during
6282
Invenio development in order to install certain Python packages:
6383

@@ -80,6 +100,21 @@ Invenio development in order to install certain Python packages:
80100
xz
81101
zlib
82102
103+
In linux distros you need this additional package (to be installed with the
104+
native package manager).
105+
106+
If using CentOS:
107+
108+
.. code-block:: console
109+
110+
$ yum install libffi-devel
111+
112+
If using Ubuntu:
113+
114+
.. code-block:: console
115+
116+
$ sudo apt-get install libffi-dev
117+
83118
Following are CLI tools that are useful during development:
84119

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

178-
Linux
179-
~~~~~
180-
181-
Want to write it? Contact us on the chat!
182-
183213
Editor
184214
------
185215
You can use any code editor of your choice. Here we give a brief overview of

0 commit comments

Comments
 (0)