From 09e1ea5fd24f1501670b4bdd4b7617492705ac79 Mon Sep 17 00:00:00 2001 From: neumond Date: Sun, 25 Dec 2016 16:52:06 +0300 Subject: [PATCH] Fix for release --- README.md | 38 ++++++++++++++++++++++++-------------- setup.cfg | 2 +- 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6aeb0d9..e670897 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,35 @@ Binding made as from-scratch code generator, outputting msvc project. -## Requirements +## Precompiled installation + +Requirements: - Windows 7 32 bit (just exactly SSCAIT requirement) NOTE: I couldn't successfully run BWAPI injector under Wine, although recently I've been told [it's possible](https://github.com/TorchCraft/TorchCraft/blob/master/docs/user/bwapi_on_linux.md). - [Python 3.5](https://www.python.org/ftp/python/3.5.2/python-3.5.2.exe) +- Installed BWAPI and SC + +``` +pip install pybrood +``` + +## Documentation + +[Read the docs](http://pybrood.readthedocs.io/en/latest/) + +## Compiling from source + +Additional requirements: + - [Visual C++ build tools](http://landinghub.visualstudio.com/visual-cpp-build-tools) or complete Visual Studio. NOTE: pick the version of compiler/studio considering [build tools used by python](https://wiki.python.org/moin/WindowsCompilers) - [BWAPI 4.1.2 sources](https://github.com/bwapi/bwapi/releases/tag/v4.1.2) you need `BWAPI.lib` and `BWAPIClient.lib` built against chosen compiler to link pybrood module - Most fresh (dec 2016) [Pybind11 headers](https://github.com/pybind/pybind11) -## Building BWAPI.lib and BWAPIClient.lib +#### Building BWAPI.lib and BWAPIClient.lib You may experience "access denied" errors while working directly in "program files/BWAPI". Better use separately cloned git repo of BWAPI where you have full access. @@ -67,7 +83,7 @@ Otherwise you can use usual cmd shell. Output file is `bwapi/lib/BWAPIClient.lib`. -## Building Pybrood +#### Building Pybrood 1. Setup paths in [config.py](generator/config.py). 2. Run the generator `python3.5 -m generator`. @@ -75,14 +91,8 @@ Otherwise you can use usual cmd shell. 4. Copy/symlink `output/Release/inner.pyd` into `pybrood` directory. `inner.pyd` is a required submodule of `pybrood`. 5. Now you should be able to `import pybrood`. - -## Documentation - -[Read the docs](http://pybrood.readthedocs.io/en/latest/) - -You can also build your local copy of documentation after running the generator: - -``` -cd output/docs/ -sphinx-build . -b html _build/html -``` +6. Optionally you can build your local copy of documentation: + ``` + cd output/docs/ + sphinx-build . -b html _build/html + ``` diff --git a/setup.cfg b/setup.cfg index 3ef42a3..7e70362 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,3 +1,3 @@ [bdist_wheel] -python-tag = py35 +python-tag = py3 plat-name = win32