Documentation updates.

pull/7/head
Ferry Boender 9 years ago
parent f6f482756a
commit fef4ee1f62
  1. 13
      README.md
  2. 3
      doc/MANUAL.md

@ -1,8 +1,5 @@
# ScriptForm # ScriptForm
## About
A stand-alone webserver that automatically generates forms from JSON to serve A stand-alone webserver that automatically generates forms from JSON to serve
as frontends to scripts. 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 validated and the associated script is called. Data entered in the form is
passed to the script through the environment. 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. - Very rapidly construct forms with backends.
- Completely standalone HTTP server; only requires Python. - 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 response to the client. The last one lets you stream images or binaries to
the browser. the browser.
### Use-cases ## Use-cases
Scriptform is very flexible and as such serves many use-cases. Most of these 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 revolve around giving non-technical users a user friendly way to safely run

@ -1,4 +1,4 @@
# Scriptform Manual # <a name="manual">Scriptform Manual</a>
This is the manual for version %%VERSION%%. 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 This concludes the tutorial for Scriptform, although it has a lot more to
offer. Some suggestions on further reading materials: 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. * [Script execution](#script_execution): Details on how scripts are executed.
* [Users](#users): Scriptform can do user management. * [Users](#users): Scriptform can do user management.
* [Form customization](#cust): Learn how to customize your forms. * [Form customization](#cust): Learn how to customize your forms.

Loading…
Cancel
Save