Skip to content

Commit

Permalink
python: add instructions for PyPi packages
Browse files Browse the repository at this point in the history
  • Loading branch information
aquynh committed Feb 3, 2015
1 parent ca10128 commit e9be7ec
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 4 deletions.
11 changes: 11 additions & 0 deletions bindings/python/README.TXT
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
0. This documentation explains how to install Python binding for Capstone
from source. If you want to install it from PyPi package, see the below
docs instead:

- README.pypi-src: How to compile the Capstone core & install binding
at the same time from PyPi package "capstone"

- README.pypi-win: How to install binding for Windows from PyPi package
"capstone-windows". Note that this package already has prebuilt core
inside, so no compilation is needed.

1. To install pure Python binding on *nix, run the command below:

$ sudo make install
Expand Down
11 changes: 8 additions & 3 deletions bindings/python/README.pypi-src
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
NOTE: This package "capstone" includes source code of the core of Capstone.
NOTE: This PyPi package "capstone" includes source code of the core of Capstone.
So installing this would also compile the core with C compiler (either "gcc" or
"msvc" on Windows).

For Windows, if you do not want to compile the core, install package "capstone_win"
instead, which already has the prebuilt core inside.
On Windows, MSVC needs compiler environmental setup, you would need to either
run "pip install capstone" or "python setup.py install" from "Developer Command
Prompt".

For Windows, if you do not want to compile the core, try the "capstone-windows"
package instead, which already has the prebuilt core inside.

--------------------------------------------------------------------------------

Capstone is a disassembly framework with the target of becoming the ultimate
Expand Down
4 changes: 3 additions & 1 deletion bindings/python/README.pypi-win
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
NOTE: This package includes prebuilt Windows core of Capstone, so no external
Capstone library is needed.
To compile from source, see package "capstone".

To compile from source, see PyPi package "capstone" instead.

--------------------------------------------------------------------------------

Capstone is a disassembly framework with the target of becoming the ultimate
Expand Down

0 comments on commit e9be7ec

Please sign in to comment.