Update README

This commit is contained in:
Sunil Mohan Adapa 2014-08-31 17:35:21 +05:30
parent 9b60347282
commit c62f0cfa72
2 changed files with 14 additions and 12 deletions

View File

@ -1,6 +1,4 @@
% PLINTH(1) Version 0.1 | Plinth User Manual
%
% February 2011
% Plinth User Manual
# Introduction
@ -8,10 +6,6 @@
plinth - a web front end for administering every aspect of a Freedom Box.
## Synopsis
plinth.py
## Description
The Freedom Box is a net appliance conceived by Eben Moglen. It
@ -45,10 +39,14 @@ servers. Basic users should never even know those options exist.
## Getting Started
See the INSTALL file for additional details. Run:
See the INSTALL file for additional details and dependencies. To install run:
$ make
$ sudo python setup.py install
Once make finishes, run Plinth on the local system with:
Run Plinth on the local system with:
$ bash start.sh
$ sudo plinth
## Contributing
See the HACKING file for contributing to Plinth.

View File

@ -40,7 +40,11 @@ oneline.txt: Makefile
$(SOURCES):
@rm -f $@
@ln -s ../$(patsubst %.mdwn,%,$@) $@
if [ -f ../$(patsubst %.mdwn,%.md,$@) ]; then \
ln -s ../$(patsubst %.mdwn,%.md,$@) $@; \
else \
ln -s ../$(patsubst %.mdwn,%,$@) $@; \
fi
../TODO : $(TODO_SOURCES) Makefile
grep -ro --exclude=.git* --exclude=plinth.1 --exclude=*.tex --exclude=*.html \