From 613c78a97f527b0ea8be27ff1de97249124d9a51 Mon Sep 17 00:00:00 2001 From: vjurenka Date: Sun, 28 Feb 2016 19:47:26 +0100 Subject: [PATCH] readme --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 40f6d2e..46c776b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ BWMirror API ========= -BWMirror API allows you to treat native BWAPI C/C++ objects as if they were Java objects. +## Directory explanation -The main class of the generator is generator.CJavaPipeline +- bwapi-data/ : just some BWTA analyzed maps, so you can test the API in real game +- bwapi4-includes/ : the headers from BWAPI4, for now, just paste the headers here, the generators uses these to create the .java files and then the .cpp +- bwta2-c/ : the headers from BWTA2, same as above +- c4/ : the final .cpp, generated by the project, kept in the repo just as a showcase +- lib/ : only jsoup to parse htmls with documentation +- manual-bwapi/ : .java files which are added to the API, used to inject custom code. Used for **BWAPI3** +- manual-bwapi4/ : .java files which are added to the API, used to inject custom code. Used for **BWAPI4** + + +- javadoc_script.bat : script to generate javadoc for API, currently uses absolute paths, should be refactored +- gmp, mpfr dlls : these are required for BWTA2, if anyone managed to get static versions of these let me know + +TODO: improve naming + +## Instructions to run the generator + +Slightly outdated version can be found [here](https://docs.google.com/document/d/1KlTohhZP-4Ob_tvTfxhVKq27Uvxemhnf_c7JEN_3Ttc/edit#heading=h.l32mh2nk44mf) + +TODO: finish the guide \ No newline at end of file