diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..9aa43e5 --- /dev/null +++ b/readme.md @@ -0,0 +1,25 @@ +# staticwiki + +Yet another low-effort tool for rendering MediaWiki XML dumps to static html +pages. + +## Features + +- partial wikitext support +- can accept bzip2 compressed streams. +- can output tar stream (could be piped to mksquashfs to recompress without + writing to disk) +- horribly bad code :) + +## Usage + +- clone repo +- obtain rustc (tested with nightly) +- `cargo install --path .` +- Get help: `staticwiki --help` +- Convert to squashfs: + `staticwiki --bzip2 --tar < dump.xml.bz2 | mksquashfs - wiki.sfs -tar -comp zstd` + +## License + +`AGPL-3.0-only` |