From 0498085a1cf65fc8cb33ebebf25e76dce8ffca8e Mon Sep 17 00:00:00 2001 From: Nguyen Anh Quynh Date: Tue, 3 Feb 2015 10:20:30 +0800 Subject: [PATCH] python: add README.pypi* --- bindings/python/MANIFEST.in | 2 ++ bindings/python/Makefile | 9 ++++++- bindings/python/README.pypi-src | 47 +++++++++++++++++++++++++++++++++ bindings/python/README.pypi-win | 43 ++++++++++++++++++++++++++++++ 4 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 bindings/python/README.pypi-src create mode 100644 bindings/python/README.pypi-win diff --git a/bindings/python/MANIFEST.in b/bindings/python/MANIFEST.in index 236f6bdb..0197892a 100644 --- a/bindings/python/MANIFEST.in +++ b/bindings/python/MANIFEST.in @@ -1,2 +1,4 @@ recursive-include src * +recursive-include prebuilt * include LICENSE.TXT +include README diff --git a/bindings/python/Makefile b/bindings/python/Makefile index 143f9917..00265556 100644 --- a/bindings/python/Makefile +++ b/bindings/python/Makefile @@ -48,26 +48,33 @@ install_cython: sdist: rm -rf prebuilt/win64/*.dll rm -rf prebuilt/win32/*.dll + rm -rf README + mv README.pypi-src README python setup.py sdist # build Python package with source sdist3: rm -rf prebuilt/win64/*.dll rm -rf prebuilt/win32/*.dll + rm -rf README + mv README.pypi-src README python3 setup.py sdist # build Python package with prebuilt core sdist_bin: rm -rf src/ + rm -rf README + mv README.pypi-win README python setup.py sdist # build Python package with prebuilt core sdist3_bin: rm -rf src/ + mv README.pypi-win README python3 setup.py sdist clean: - rm -rf $(OBJDIR) src/ + rm -rf $(OBJDIR) src/ README rm -f capstone/*.so rm -rf prebuilt/win64/*.dll rm -rf prebuilt/win32/*.dll diff --git a/bindings/python/README.pypi-src b/bindings/python/README.pypi-src new file mode 100644 index 00000000..78f4368f --- /dev/null +++ b/bindings/python/README.pypi-src @@ -0,0 +1,47 @@ +NOTE: This 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. +-------------------------------------------------------------------------------- + +Capstone is a disassembly framework with the target of becoming the ultimate +disasm engine for binary analysis and reversing in the security community. + +Created by Nguyen Anh Quynh, then developed and maintained by a small community, +Capstone offers some unparalleled features: + +- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc, + SystemZ, XCore and X86 (including X86_64). + +- Having clean/simple/lightweight/intuitive architecture-neutral API. + +- Provide details on disassembled instruction (called “decomposer” by others). + +- Provide semantics of the disassembled instruction, such as list of implicit + registers read & written. + +- Implemented in pure C language, with lightweight wrappers for C++, C#, Go, + Java, NodeJS, Ocaml, Python, Ruby & Vala ready (available in main code, + or provided externally by the community). + +- Native support for all popular platforms: Windows, Mac OSX, iOS, Android, + Linux, *BSD, Solaris, etc. + +- Thread-safe by design. + +- Special support for embedding into firmware or OS kernel. + +- High performance & suitable for malware analysis (capable of handling various + X86 malware tricks). + +- Distributed under the open source BSD license. + +Further information is available at http://www.capstone-engine.org + + +[License] + +This project is released under the BSD license. If you redistribute the binary +or source code of Capstone, please attach file LICENSE.TXT with your products. diff --git a/bindings/python/README.pypi-win b/bindings/python/README.pypi-win new file mode 100644 index 00000000..2455b412 --- /dev/null +++ b/bindings/python/README.pypi-win @@ -0,0 +1,43 @@ +NOTE: This package "capstone-win" includes prebuilt Windows core of Capstone. +To compile from source, see package "capstone". +-------------------------------------------------------------------------------- + +Capstone is a disassembly framework with the target of becoming the ultimate +disasm engine for binary analysis and reversing in the security community. + +Created by Nguyen Anh Quynh, then developed and maintained by a small community, +Capstone offers some unparalleled features: + +- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc, + SystemZ, XCore and X86 (including X86_64). + +- Having clean/simple/lightweight/intuitive architecture-neutral API. + +- Provide details on disassembled instruction (called “decomposer” by others). + +- Provide semantics of the disassembled instruction, such as list of implicit + registers read & written. + +- Implemented in pure C language, with lightweight wrappers for C++, C#, Go, + Java, NodeJS, Ocaml, Python, Ruby & Vala ready (available in main code, + or provided externally by the community). + +- Native support for all popular platforms: Windows, Mac OSX, iOS, Android, + Linux, *BSD, Solaris, etc. + +- Thread-safe by design. + +- Special support for embedding into firmware or OS kernel. + +- High performance & suitable for malware analysis (capable of handling various + X86 malware tricks). + +- Distributed under the open source BSD license. + +Further information is available at http://www.capstone-engine.org + + +[License] + +This project is released under the BSD license. If you redistribute the binary +or source code of Capstone, please attach file LICENSE.TXT with your products.