• R/O
  • SSH
  • HTTPS

ogup: Commit


Commit MetaInfo

Revision13 (tree)
Time2020-12-25 17:25:46
Authormateuszviste

Log Message

readme

Change Summary

Incremental Difference

--- trunk/readme.txt (nonexistent)
+++ trunk/readme.txt (revision 13)
@@ -0,0 +1,68 @@
1+
2+This directory contains the source files of the OGUP project.
3+
4+The web homepage of the ogup project is located at http://ogup.osdn.io
5+
6+
7+=== BUILD ====================================================================
8+
9+Building the OGUP requires an ANSI C compiler (preferrably gcc or clang).
10+Executing the buildall.sh script will compile all OGUP modules (dynamic
11+frontend gophermaps, as well as the 'gopherjoker' crawler).
12+
13+
14+=== RUN ======================================================================
15+
16+Once the project is built, the 'frontend' directory can be served with a
17+gopher server to present users with the OGUP interface.
18+NOTE: This has been tested exclusively with the Motsognir gopher server, and
19+is unlikely to function properly with a different gopher server.
20+
21+If the build process was successful, a 'gopherjoker' binary should have
22+appeared in the gopherjoker directory. This is a gopher crawler that will
23+spider the gopherspace. It should be loaded as such:
24+
25+ $ gopherjoker ogupdb.dat ogupdb.cnt
26+
27+ogupdb.dat is a comma-separated-value text file that gopherjoker uses as its
28+database of known gopher servers. ogupdb.cnt is a file that contains only
29+global counters of known servers, that is used by the OGUP frontend.
30+
31+The ogupdb.dat and ogupdb.cnt files should be stored in the directory where
32+OGUP's frontend lives, so the frontend always has most up-to-date data.
33+
34+Both ogupdb.dat and ogupdb.cnt are updated only once an hour by gopherjoker,
35+to avoid too much filesystem updates.
36+
37+
38+=== LEARNING NEW SERVERS =====================================================
39+
40+gopherjoker learns about new gopher servers by discovering menu listings of
41+existing (known) servers. It is also possible to hand-feed gopherjoker with
42+new servers - to do so, a file '/tmp/gjoker_newhosts.csv' must be created. It
43+should contain the list of new servers for gopherjoker, one server per line.
44+
45+
46+=== LICENSE ==================================================================
47+
48+All OGUP files are made available under the terms of the MIT License.
49+
50+Copyright (C) 2019-2021 Mateusz Viste
51+
52+Permission is hereby granted, free of charge, to any person obtaining a copy
53+of this software and associated documentation files (the "Software"), to deal
54+in the Software without restriction, including without limitation the rights
55+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
56+copies of the Software, and to permit persons to whom the Software is
57+furnished to do so, subject to the following conditions:
58+
59+The above copyright notice and this permission notice shall be included in all
60+copies or substantial portions of the Software.
61+
62+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
63+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
64+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
65+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
66+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
67+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
68+SOFTWARE.
Show on old repository browser