2f33e7f4b5
Seems to be working alright, and it does clean up a few things. The biggest missing thing right now is schema-based validation for some query parameters. I'm also seeing opportunities for FU::Pg to act as a hash/shorthash codec, simplifying some error-prone manual conversions.
31 lines
908 B
Markdown
31 lines
908 B
Markdown
# 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: 5.36+
|
|
- postgresql: A somewhat recent version
|
|
- rust: Version who-knows-which
|
|
|
|
### Web front-end
|
|
|
|
- FU
|
|
- 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.
|