Clean up README.rst

pushfoo · Feb 6, 2023 · 389b3a8 · 389b3a8
1 parent bfc826a
commit 389b3a8
Showing 1 changed file with 15 additions and 18 deletions.
diff --git a/README.rst b/README.rst
@@ -2,17 +2,19 @@
 pyc2e
 =====
 
-A pure python interface for managing the
-`Creatures Evolution Engine (c2e) <https://creatures.wiki/Creatures_Evolution_Engine>`_
-with no external dependencies. Based off of
-`Chris Double's documentation of the c2e shared memory interface <http://double.nz/creatures/developer/sharedmemory.htm>`_.
+A pure python interface for injecting scripts & reading output from the
+`Creatures Evolution Engine (c2e) <https://creatures.wiki/Creatures_Evolution_Engine>`_. The only requirements are:
 
-**This isn't ready for real-world use yet. It might break your Creatures 3 / DS install.**
+* A compatible c2e version
+* Python 3.7+
+* Running the interface in the same permission space as the target c2e instance
 
-See bottom for more details.
+Created using
+`Chris Double's documentation of the c2e shared memory interface <http://double.nz/creatures/developer/sharedmemory.htm>`_.
 
-License TBD, probably a BSD or LGPL.
+**Warning: This may break your Creatures 3 / DS install.**
 
+License TBD, probably a BSD or LGPL.
 
 ---------------------------
 How to inject CAOS from CLI
@@ -39,16 +41,11 @@ and arbitrary strings passed from the command line: ::
 
     pyc2e inject --caos "outs \"testing\""
 
-On windows, you might need to omit the escapes around the quotes  .
-
------------------------------------------
-Not ready for use in production, very WIP
------------------------------------------
-
-At the moment, it only handles running & injecting `CAOS <https://creatures.wiki/CAOS>`_ on Windows.
-It's posted early because some developers need it. Much of the implementation may miss edge cases or just be ugly.
+On windows, you might need to omit the escapes around the quotes.
 
-Engine, config, and launch management for testing and fuzzing will be added later. Linux support will be
-added later as well. Assume just about everything could change.
+---------------------
+Current functionality
+---------------------
 
-Assumes Python 3.7+, but it might work on lower versions.
+At the moment, this project handles running & injecting `CAOS <https://creatures.wiki/CAOS>`_ on Windows.
+The Linux implementation is partially complete due to lack of interest from the game's community. Engine, config, and launch management for testing and fuzzing may added later.