From a7726cbbd634c3d61863fbd9bb17bce4fdb8e907 Mon Sep 17 00:00:00 2001 From: "gergely.erdelyi" Date: Mon, 1 Sep 2008 18:55:03 +0000 Subject: [PATCH] More doc updates --- BUILDING.txt | 10 ++++++---- README.txt | 35 +++++++++++++++++++++-------------- STATUS.txt | 2 +- 3 files changed, 28 insertions(+), 19 deletions(-) diff --git a/BUILDING.txt b/BUILDING.txt index d13fc1a..c262902 100644 --- a/BUILDING.txt +++ b/BUILDING.txt @@ -5,16 +5,17 @@ Building From Source -------------------- REQUIREMENTS +------------ [Tested versions are in brackets] - IDA and IDA SDK [5.1] http://www.datarescue.com/idabase/ - - Python [2.4.4, 2.5.1] + - Python [2.5.1] http://www.python.org/ - - Simplified Wrapper Interface Generator (SWIG) [1.3.31] + - Simplified Wrapper Interface Generator (SWIG) [1.3.36] http://www.swig.org/ - Unix utilities (GNU patch on Windows): @@ -22,14 +23,15 @@ REQUIREMENTS http://unxutils.sourceforge.net/ or http://www.cygwin.com/ - - GCC on Linux and Mac OS X [4.1.3] + - GCC on Linux and Mac OS X [4.0.1, 4.1.3] Comes with your distribution - - Microsoft Visual C on Windows [Microsoft Visual C++ 2005 Express Edition] + - Microsoft Visual C on Windows [Microsoft Visual C++ 2008 Express Edition] http://msdn.microsoft.com/vstudio/express/visualc/ BUILDING +-------- Make sure all the needed tools (compiler, swig) are on the PATH. diff --git a/README.txt b/README.txt index f1745e2..8e5bc30 100644 --- a/README.txt +++ b/README.txt @@ -3,6 +3,7 @@ IDAPython - Python plugin for Interactive Disassembler Pro ---------------------------------------------------------- WHAT IS IDAPTYHON? +------------------ IDAPython is an IDA plugin which makes it possible to write scripts for IDA in the Python programming language. IDAPython provides full @@ -12,13 +13,30 @@ Check the scripts in the examples directory to get an quick glimpse. AVAILABILITY +------------ -Latest versions of IDAPython are available from +Latest stable versions of IDAPython are available from + http://www.d-dome.net/idapython/ -http://www.d-dome.net/idapython/ +Development builds are available from + http://code.google.com/p/idapython/ + + +RESOURCES +--------- + +The full function cross-reference is readable online at + http://www.d-dome.net/idapython/reference/ + +Bugs and enhancement requests should be submitted to + http://code.google.com/p/idapython/issues/list + +Mailing list for the project is hosted by Google Groups at + http://groups.google.com/group/idapython INSTALLATION FROM BINARIES +-------------------------- 1, Install Python 2.5 from http://www.python.org/ 2, Copy the directory python\ to the IDA install directory @@ -26,6 +44,7 @@ INSTALLATION FROM BINARIES USAGE +----- The plugin has three hotkeys: @@ -56,15 +75,3 @@ C:\Documents and Settings\%USER%\Application Data\Datarescue\IDA Pro The user init file is read and executed at the end of the init process. - -THANKS - -This project is sponsored by F-Secure Corporation by allowing me to -use some company time and resources for development. Please note that -F-Secure is only sponsoring the project, the company does not provide -any formal support for this software. Questions, comments, bug reports -should be directed to the author. - -F-Secure Corporation's website is located at - -http://www.F-Secure.com/ diff --git a/STATUS.txt b/STATUS.txt index 82bf7d3..4047a8c 100644 --- a/STATUS.txt +++ b/STATUS.txt @@ -54,7 +54,7 @@ pro.h - COMPLETE (some needed SWIGs) queue.hpp - INCOMPLETE (one FIXME) regex.h - EXCLUDED search.hpp - INCOMPLETE (one FIXME) -segment.hpp - INCOMPLETE (no SWIGs, few FIXMEs) +segment.hpp - COMPLETE sistack.hpp - EXCLUDED srarea.hpp - INCOMPLETE (not wrapped at all) strlist.hpp - COMPLETE