annotate README.txt @ 1120:b2bca5f6d0ff default tip

Cosmetic cleanup: remove trailing whitespace.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 13 Dec 2020 13:47:13 +0200
parents 43c384a37d19
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
572
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 FAPWeb - Simple Web-based Demoparty Management System
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 =====================================================
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3 Programmed and designed by Matti Hämäläinen (ccr/TNSP)
1077
7cf832128e68 Update copyright.
Matti Hamalainen <ccr@tnsp.org>
parents: 1009
diff changeset
4 (C) Copyright 2012-2017 Tecnic Software productions (TNSP)
572
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6 Distributed under a 3-clause BSD style license, see COPYING.txt
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
9 [rest of this really needs to be written some day]
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
10
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
11
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
12 Introduction
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
13 ============
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
14 FAPWeb is a simple web-based system for managing a web-site for a
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
15 demoparty (see http://en.wikipedia.org/wiki/Demoparty ), including
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16 facilities for:
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
17
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18 - Web-pages with party information (compos) etc
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
19 - Visitor registration
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
20 - On-screen beamer slides for competitions and announcements
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21 - Submitting competition entries (currently no "user-submission" tho)
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22 - On-line voting
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
24 - Etc .. with more features possibly coming as they are implemented.
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25
1009
5b53b359c659 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 1002
diff changeset
26 The system has been used for three evolutions of Finnish Amiga Party,
572
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27 aka "FAP", thus the somewhat amusing name for the software.
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30 Requirements
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31 ============
741
1a4a5267aabe Update README a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 572
diff changeset
32
1117
43c384a37d19 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 1077
diff changeset
33 - PHP 7.0 or later (tested on PHP 7.0 (Debian patched))
741
1a4a5267aabe Update README a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 572
diff changeset
34 Both PHP for http server and CLI are required.
572
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
35
1117
43c384a37d19 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 1077
diff changeset
36 - PHP GraphicsMagick wrapper. In Debian, it is "php7-imagick".
572
0bb09b40b411 Add a license and a rather empty README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
37
1117
43c384a37d19 Update README.
Matti Hamalainen <ccr@tnsp.org>
parents: 1077
diff changeset
38 - SQL database. FAPWeb supports at least PostgreSQL and maybe MySQL
741
1a4a5267aabe Update README a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 572
diff changeset
39 PDO database backends, also SQLite3 is supported for development
1a4a5267aabe Update README a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 572
diff changeset
40 purposes. However, SQLite3 should NOT BE USED for a production
1a4a5267aabe Update README a bit.
Matti Hamalainen <ccr@tnsp.org>
parents: 572
diff changeset
41 website - it can not handle simultaneous access very well at all.