Browse Source

Convert README to markdown + update git URLs

Yorhel 9 months ago
parent
commit
cfc656bf12
3 changed files with 43 additions and 42 deletions
  1. 0
    33
      README
  2. 34
    0
      README.md
  3. 9
    9
      www/index.pl

+ 0
- 33
README View File

@@ -1,33 +0,0 @@
1
-The Manned.org Source Code
2
---------------------------
3
-
4
-  This repository holds the source code of Manned.org. For a description of the
5
-  site, check out http://manned.org/info/about.
6
-  
7
-  Ironically, documentation about how things work is completely lacking.
8
-
9
-
10
-
11
-Requirements
12
-
13
-  General:
14
-    perl: A somewhat recent version (no idea which, due to my XS usage)
15
-    postgresql: Also a somewhat recent version
16
-    rust + cargo (1.13+)
17
-
18
-  www/ & lib/ & webs/: (Website)
19
-    DBI
20
-    DBD::Pg
21
-    TUWF
22
-    JSON::XS
23
-    AnyEvent
24
-
25
-  util/ & indexer/: (DB updating and package synchronisation stuff)
26
-    curl
27
-    psql
28
-
29
-
30
-Contact
31
-
32
-  contact@manned.org
33
-

+ 34
- 0
README.md View File

@@ -0,0 +1,34 @@
1
+# The Manned.org Source Code
2
+
3
+This repository holds the source code of Manned.org. For a description of the
4
+site, check out [https://manned.org/info/about](https://manned.org/info/about).
5
+  
6
+Ironically, documentation about how things work is completely lacking.
7
+
8
+## Requirements
9
+
10
+- perl: A somewhat recent version (no idea which, due to my XS usage)
11
+- postgresql: Also a somewhat recent version
12
+- rust + cargo (1.13+)
13
+
14
+### Web front-end
15
+
16
+- DBI
17
+- DBD::Pg
18
+- TUWF
19
+- JSON::XS
20
+- AnyEvent
21
+
22
+### Man page indexer
23
+
24
+- curl
25
+- psql
26
+
27
+## File structure
28
+
29
+- **indexer/** -> The Rust program that scans package repositories for updates, fetches new packages and extracts the man pages.
30
+- **lib/ManUtils/** -> Perl/XS helper module to format man pages into HTML (uses **web/**).
31
+- **sql/** -> Database schema & updates.
32
+- **util/** -> Cron job and scripts to run **indexer/** on the right repositories.
33
+- **web/** -> Badly named Rust library to convert man pages into HTML.
34
+- **www/** -> The web front-end.

+ 9
- 9
www/index.pl View File

@@ -181,10 +181,10 @@ sub about {
181 181
    passed through <a href="http://www.gnu.org/software/groff/">groff</a> to
182 182
    render them in (mostly) the same way as they are displayed in your terminal.
183 183
    <br /><br />
184
-   This website is <a href="https://g.blicky.net/manned.git/">open source</a>
185
-   (MIT licensed) and written in a combination of Perl and Rust. The entire
186
-   PostgreSQL database is available for download (see "Database download"
187
-   below).
184
+   This website is <a href="https://code.blicky.net/yorhel/manned">open
185
+   source</a> (MIT licensed) and written in a combination of Perl and Rust. The
186
+   entire PostgreSQL database is available for download (see "Database
187
+   download" below).
188 188
   _
189 189
   end;
190 190
 
@@ -317,10 +317,10 @@ sub about {
317 317
    <a href="/wget">wget's -c</a> or <a href="/curl">curl's -C</a>.
318 318
    <br /><br />
319 319
    The database schema is "documented" at <a
320
-   href="https://g.blicky.net/manned.git/tree/sql/schema.sql">schema.sql</a> in
321
-   the git repo. Note that these dumps don't constitute a stable API and, while
322
-   this won't happen frequently, incompatible schema changes or Postgres major
323
-   version bumps may occur.
320
+   href="https://code.blicky.net/yorhel/manned/src/branch/master/sql/schema.sql">schema.sql</a>
321
+   in the git repo. Note that these dumps don't constitute a stable API and,
322
+   while this won't happen frequently, incompatible schema changes or Postgres
323
+   major version bumps may occur.
324 324
   _
325 325
   end;
326 326
 
@@ -885,7 +885,7 @@ sub htmlFooter {
885 885
      lit 'All manual pages are copyrighted by their respective authors.
886 886
        | <a href="/info/about">About manned.org</a>
887 887
        | <a href="mailto:contact@manned.org">Contact</a>
888
-       | <a href="https://g.blicky.net/manned.git/">Source</a>';
888
+       | <a href="https://code.blicky.net/yorhel/manned">Source</a>';
889 889
     end;
890 890
     script type => 'text/javascript', src => '/man.js', '';
891 891
    end;

Loading…
Cancel
Save