Browse Source

adding usage

pixelbath 3 years ago
parent
commit
681ab04adb
1 changed files with 16 additions and 1 deletions
  1. 16 1
      README.md

+ 16 - 1
README.md

@@ -1,7 +1,22 @@
 All code and content in this repository is released into the public domain. Any code not written explicitly by me is already in the public domain. For more information, see https://gitlab.com/drummyfish/anarch.
 
-This code uses a lot of drummyfish's map converter code as-is (even kept the `printC()` method); I simply wrapped it in a class to access its sweet, creamy internals.
+## Usage
+This code uses a lot of drummyfish's `img2map.py` code as-is; I simply wrapped it in a class to access its sweet, creamy internals.
 
+The plan is to get this app to a point where you point it at an assets folder and either create a new map or edit an existing map image. From that point, it can export classes or images, whichever is preferred.
+
+To use the C generator by itself, just create a python script with the following:
+
+```Python
+from anarchmap import AnarchMap
+
+map = AnarchMap('./level0.gif')
+map.printC()
+```
+
+You can then use that file similar to drummyfish's original script: `python3 myscript.py > level0.c`
+
+## License
 I release everything in this repository under CC0 1.0 (public domain, https://creativecommons.org/publicdomain/zero/1.0/) + a waiver of all other IP rights (including patents), which is as follows:
 
 _Each contributor to this work agrees that they waive any exclusive rights, including but not limited to copyright, patents, trademark, trade dress, industrial design, plant varieties and trade secrets, to any and all ideas, concepts, processes, discoveries, improvements and inventions conceived, discovered, made, designed, researched or developed by the contributor either solely or jointly with others, which relate to this work or result from this work. Should any waiver of such right be judged legally invalid or ineffective under applicable law, the contributor hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to this right._