From fd888ed32b3d5767af598761921082bcc0686145 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Tue, 1 Mar 2022 04:48:41 +0000 Subject: docs(readme): punctuation, grammar, sections --- README.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 79931bb..15b6eb3 100644 --- a/README.rst +++ b/README.rst @@ -8,14 +8,14 @@ What? A decoder and utility for the Flipnote Studios :code:`.ppm` animation format. -Why this over that? -------------------- +Why this implementation over `the original `_? +------------------------------------------------------------------------------------------------- This implementation is -- `SIGNIFICANTLY faster <#speed>`_ -- implemented in safe Rust (a language with strict type-checking!) -- being actively updated +- `SIGNIFICANTLY faster <#speed>`_, +- implemented in safe Rust (a language with strict type-checking!), +- and being actively updated. Speed ^^^^^ @@ -32,6 +32,14 @@ while ppm-parser took an average of 358.2232 milliseconds. Rust versus Python isn't very fair, however, this benchmark shows the speed improvements that para brings to the table. +Things To Come +-------------- + +- Support for other formats (namely :code:`.kwz`) +- Optimizations here and there +- Friendlier CLI +- Possible GUI + Getting up and Running ---------------------- -- cgit v1.2.3