nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-04-29 10:10:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

HACKING: Add extra development requirements

Browse Source 
[sunil: Reword the extra requirements to explain when they are needed]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
This commit is contained in:
Fioddor Superconcentrado 2020-09-14 19:09:47 +00:00 committed by Sunil Mohan Adapa
parent f69d8289f6
commit d588e7fa25
No known key found for this signature in database
GPG Key ID: 43EA1CFF0AA7C5F2
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
HACKING.md
View File

@ -4,13 +4,23 @@
FreedomBox is built as part of Debian GNU/Linux. However, you don't need to FreedomBox is built as part of Debian GNU/Linux. However, you don't need to
install Debian to do development for FreedomBox. FreedomBox development is install Debian to do development for FreedomBox. FreedomBox development is
typically done on a container or a Virtual Machine. typically done with a container or a Virtual Machine.
* For running a container, you need systemd containers, Git, Python and a * For running a container, you need systemd containers, Git, Python3 and a
sudo-enabled user. This approach is recommended. sudo-enabled user. This approach is recommended.
* For running a VM, you can work on any operating system that can install latest * For running a VM, you can work on any operating system that can install latest
versions of Git, Vagrant and VirtualBox. versions of Git, Vagrant and VirtualBox.
In addition:
- To run code quality checks you need flake8 and yapf. These may be installed
inside the container with Python3 and pip but installing them on host leads to
smoother development experience.
- To update translation strings on the host machine, you need Django and gettext
to be installed on host machine. These can be installed with Python3 and pip.
- You need Mumble voice chat software to participate in bi-weekly live
development discussions.
## Using Containers ## Using Containers
The `./container` script shipped with FreedomBox source code can manage the The `./container` script shipped with FreedomBox source code can manage the
@ -422,7 +432,7 @@ For more information on translations: https://wiki.debian.org/FreedomBox/Transla
## Application Icons ## Application Icons
When adding a new App into FreedomBox, an icon is needed to represent the app in When adding a new App into FreedomBox, an icon is needed to represent the app in
the application view and for shortcuts in the front page. The following the the application view and for shortcuts in the front page. Follow these
guidelines for creating an app icon: guidelines for creating an app icon:
- Use SVG format. - Use SVG format.