diff --git a/README b/README.md similarity index 85% rename from README rename to README.md index 6c8382b54..ad36e0c2a 100644 --- a/README +++ b/README.md @@ -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. diff --git a/doc/Makefile b/doc/Makefile index 0243a07aa..e6601e93d 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -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 \