From c318ecd580aafa3c86896141c92fffd1e4ae7800 Mon Sep 17 00:00:00 2001 From: Sunil Mohan Adapa Date: Fri, 23 Oct 2015 13:19:15 +0530 Subject: [PATCH] Update readme to links to wiki & manual - Remove repeated links - Flatten the headings - Rewrap - Add links to FreedomBox wiki and FreedomBox manual. --- README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e00732cc9..fe0daa516 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ [![Build Status](https://travis-ci.org/freedombox/Plinth.svg?branch=master)](https://travis-ci.org/freedombox/Plinth) -# Introduction +# Plinth -## Name +[Plinth](https://wiki.debian.org/FreedomBox/Plinth) - a web front end +for administering [FreedomBox](https://freedomboxfoundation.org/) -[Plinth](https://wiki.debian.org/FreedomBox/Plinth) - a web front end for administering [FreedomBox](https://freedomboxfoundation.org/) +# Description -## Description - -[FreedomBox](https://freedomboxfoundation.org/) is a community project to develop, design and promote +FreedomBox is a community project to develop, design and promote personal servers running free software for private, personal communications. It is a networking appliance designed to allow interfacing with the rest of the Internet under conditions of @@ -17,15 +16,20 @@ blog, wiki, website, social network, email, web proxy and a Tor relay on a device that can replace your Wi-Fi router so that your data stays with you. -[Plinth](https://wiki.debian.org/FreedomBox/Plinth) is a web interface to administer the functions of the -[FreedomBox](https://freedomboxfoundation.org/). It is extensible and provides various applications of -[FreedomBox](https://freedomboxfoundation.org/) as modules. Each module or application provides simplified -user interface to control the underlying functionality. As [FreedomBox](https://freedomboxfoundation.org/) +Plinth is a web interface to administer the functions of the +FreedomBox. It is extensible and provides various applications of +FreedomBox as modules. Each module or application provides simplified +user interface to control the underlying functionality. As FreedomBox can act as a wireless router, it is possible to configure networking -from [Plinth](https://wiki.debian.org/FreedomBox/Plinth). [Plinth](https://wiki.debian.org/FreedomBox/Plinth) also allows configuration of basic system +from Plinth. Plinth also allows configuration of basic system parameters such as time zone, hostname and automatic upgrades. -## Getting Started +You can find more information about Plinth on the +[Plinth Wiki](https://wiki.debian.org/FreedomBox/Plinth) page, +the [FreedomBox Wiki](https://wiki.debian.org/FreedomBox/) and the +[FreedomBox Manual](https://wiki.debian.org/FreedomBox/Manual). + +# Getting Started See the INSTALL file for additional details and dependencies. To install run: @@ -35,6 +39,6 @@ Run Plinth on the local system with: $ sudo plinth -## Contributing +# Contributing See the HACKING file for contributing to Plinth.