@@ -20,16 +20,17 @@ System setup
20
20
We support development on macOS and Linux-based systems (development on Windows
21
21
is not supported).
22
22
23
- macOS
24
- ~~~~~
23
+ macOS/Linux
24
+ ~~~~~~~~~~~
25
25
We recommend that you install libraries and tools using the
26
26
`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 **.
28
29
29
30
**Cask packages **
30
31
31
32
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:
33
34
34
35
.. code-block :: console
35
36
@@ -48,6 +49,11 @@ Here are some recommended cask packages (only ``docker`` is required):
48
49
spectacle # organise windows with keyboard shortcuts
49
50
visual-studio-code # a text editor used by many Invenio developers
50
51
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
+
51
57
**Normal packages **
52
58
53
59
Normal packages are usually command line tools/libraries that end up in
@@ -58,6 +64,20 @@ using the command:
58
64
59
65
$ brew install <packages>
60
66
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
+
61
81
The following packages are libraries that are likely to be needed during
62
82
Invenio development in order to install certain Python packages:
63
83
@@ -80,6 +100,21 @@ Invenio development in order to install certain Python packages:
80
100
xz
81
101
zlib
82
102
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
+
83
118
Following are CLI tools that are useful during development:
84
119
85
120
.. code-block :: console
@@ -175,11 +210,6 @@ See https://docs.docker.com/docker-for-mac/#resources.
175
210
A typical sign of needed more resources, is that services are not running or
176
211
images are having problems building.
177
212
178
- Linux
179
- ~~~~~
180
-
181
- Want to write it? Contact us on the chat!
182
-
183
213
Editor
184
214
------
185
215
You can use any code editor of your choice. Here we give a brief overview of
0 commit comments