From fe1b1cb5b2327c48611d67d7a92cb8dd077073bc Mon Sep 17 00:00:00 2001 From: Sunil Mohan Adapa Date: Tue, 5 Mar 2019 13:56:51 -0800 Subject: [PATCH] README: Provide simple instruction for installing FreedomBox Provide instruction for regular users over instructions for developers. Signed-off-by: Sunil Mohan Adapa Reviewed-by: James Valleroy --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c62ed63db..2660d16f5 100644 --- a/README.md +++ b/README.md @@ -39,17 +39,24 @@ the [FreedomBox Wiki](https://wiki.debian.org/FreedomBox/) and the # Getting Started -See the INSTALL.md file for additional details and dependencies. To install run: +To have a running FreedomBox, first install Debian (Buster or higher) on a clean +machine. Then run: - $ sudo python3 setup.py install + ``` + $ sudo apt install freedombox + ``` -Run FreedomBox Service (Plinth) on the local system with: +Full instructions are available on FreedomBox +[Manual](https://wiki.debian.org/FreedomBox/Manual/)'s +[QuickStart](https://wiki.debian.org/FreedomBox/Manual/QuickStart) page. - $ sudo plinth +For instructions on running the service on a local machine from source code, see +INSTALL.md. For instructions on setting up for development purposes, see +HACKING.md. # Contributing -See the [HACKING](https://salsa.debian.org/freedombox-team/plinth/blob/master/HACKING.md) file for contributing to FreedomBox Service (Plinth). +See the [HACKING.md](https://salsa.debian.org/freedombox-team/plinth/blob/master/HACKING.md) file for contributing to FreedomBox Service (Plinth). # Localization