diff options
| author | Alexander Pickering <alexandermpickering@gmail.com> | 2017-10-29 16:22:55 -0400 |
|---|---|---|
| committer | Alexander Pickering <alexandermpickering@gmail.com> | 2017-10-29 16:22:55 -0400 |
| commit | 7b2ea4fd1a371f7d92f113387a00932516e10675 (patch) | |
| tree | 1f8ab118900ebf6d29c5e71c59ac0e76a546a19c | |
| parent | 29ea18220c1a41b40ab8bc2c8fe3d03865f5f6a2 (diff) | |
| download | sober-7b2ea4fd1a371f7d92f113387a00932516e10675.tar.gz sober-7b2ea4fd1a371f7d92f113387a00932516e10675.tar.bz2 sober-7b2ea4fd1a371f7d92f113387a00932516e10675.zip | |
Added readme
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..82366d1 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Simple Open Bug and Error Reporter + +SOBER is a smimple web-based bug reporter. It is written in ANSI C and should work on any posix-compliant platform & web server with cgi support. + +You can find a demo instance at [cogarr.net/demos/sober](https://cogarr.net/demos/sober) + +## Installation + +To install, +1. clone this repo +2. edit config.h +3. edit the first 3 lines of build.bat or build.sh +4. run the build.bat or build.sh script. +5. point your web server to the cgi-bin directory. +SOBER should set up it's files as needed. + +## Usage +People that need to use the bug tracker should have access (ex over ssh) to the deploy/bugs directory. Each bug has a id# as a filename. You can search for bugs by using grep. Ex: +`grep "0:" *` will find all open bugs + +To give feedback to the users of the site, change the 5th line in the bug report. It has the format <status>:<text> +statis can be: + +* 0 : unassigned, text MUST NOT exist +* 1 : assigned, text will be displayed +* 2 : closed, text MUST NOT exist + +## Misc +If your filesystem supports it, "lock" the file while it is being edited by a developer, so that data submitted by users is not overwritten. + |