Convert README to markdown + update git URLs

README

@@ -1,33 +0,0 @@
-The Manned.org Source Code
---------------------------
-
-  This repository holds the source code of Manned.org. For a description of the
-  site, check out http://manned.org/info/about.
-  
-  Ironically, documentation about how things work is completely lacking.
-
-
-
-Requirements
-
-  General:
-    perl: A somewhat recent version (no idea which, due to my XS usage)
-    postgresql: Also a somewhat recent version
-    rust + cargo (1.13+)
-
-  www/ & lib/ & webs/: (Website)
-    DBI
-    DBD::Pg
-    TUWF
-    JSON::XS
-    AnyEvent
-
-  util/ & indexer/: (DB updating and package synchronisation stuff)
-    curl
-    psql
-
-
-Contact
-
-  contact@manned.org
-

README.md

@@ -0,0 +1,34 @@
+# The Manned.org Source Code
+
+This repository holds the source code of Manned.org. For a description of the
+site, check out [https://manned.org/info/about](https://manned.org/info/about).
+  
+Ironically, documentation about how things work is completely lacking.
+
+## Requirements
+
+- perl: A somewhat recent version (no idea which, due to my XS usage)
+- postgresql: Also a somewhat recent version
+- rust + cargo (1.13+)
+
+### Web front-end
+
+- DBI
+- DBD::Pg
+- TUWF
+- JSON::XS
+- AnyEvent
+
+### Man page indexer
+
+- curl
+- psql
+
+## File structure
+
+- **indexer/** -> The Rust program that scans package repositories for updates, fetches new packages and extracts the man pages.
+- **lib/ManUtils/** -> Perl/XS helper module to format man pages into HTML (uses **web/**).
+- **sql/** -> Database schema & updates.
+- **util/** -> Cron job and scripts to run **indexer/** on the right repositories.
+- **web/** -> Badly named Rust library to convert man pages into HTML.
+- **www/** -> The web front-end.

www/index.pl

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