aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-02-28 20:48:41 -0800
committerGitHub <[email protected]>2022-02-28 20:48:41 -0800
commitdada969c6086b115b7998597726601053395f76d (patch)
treec594a7ca3db936b2797e6d62e905b9c5e6ca040b
parent5ba8a5f8fffc81265086422a165c06bfbbf87ade (diff)
downloadpara-dada969c6086b115b7998597726601053395f76d.tar.xz
para-dada969c6086b115b7998597726601053395f76d.zip
docs(readme): punctuation, grammar, sections
-rw-r--r--README.rst18
1 files 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 <https://github.com/Flipnote-Collective/ppm-parser>`_?
+-------------------------------------------------------------------------------------------------
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
----------------------