From fef4ee1f62ff8a4f6201e04a60ad9180a2b2d7bb Mon Sep 17 00:00:00 2001 From: Ferry Boender Date: Mon, 27 Jul 2015 13:17:41 +0200 Subject: [PATCH] Documentation updates. --- README.md | 13 ++++++++----- doc/MANUAL.md | 3 ++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 06412e8..1da6f9e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ # ScriptForm - -## About - A stand-alone webserver that automatically generates forms from JSON to serve as frontends to scripts. @@ -12,7 +9,13 @@ user can select a form and fill it out. When the user submits the form, it is validated and the associated script is called. Data entered in the form is passed to the script through the environment. -### Features +Packages are available for: + +* [Debian / Ubuntu](https://github.com/fboender/scriptform/releases) +* [RedHat / Centos](https://github.com/fboender/scriptform/releases) +* [Other operating systems](https://github.com/fboender/scriptform/releases) + +## Features - Very rapidly construct forms with backends. - Completely standalone HTTP server; only requires Python. @@ -27,7 +30,7 @@ passed to the script through the environment. response to the client. The last one lets you stream images or binaries to the browser. -### Use-cases +## Use-cases Scriptform is very flexible and as such serves many use-cases. Most of these revolve around giving non-technical users a user friendly way to safely run diff --git a/doc/MANUAL.md b/doc/MANUAL.md index b949df3..a286cfb 100644 --- a/doc/MANUAL.md +++ b/doc/MANUAL.md @@ -1,4 +1,4 @@ -# Scriptform Manual +# Scriptform Manual This is the manual for version %%VERSION%%. @@ -572,6 +572,7 @@ field definitions can be found in the '[Field types](#field_types)' chapter. This concludes the tutorial for Scriptform, although it has a lot more to offer. Some suggestions on further reading materials: +* [Full user manual](#manual): Everything you need to know. * [Script execution](#script_execution): Details on how scripts are executed. * [Users](#users): Scriptform can do user management. * [Form customization](#cust): Learn how to customize your forms.