Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tmr232 committed Oct 15, 2019
1 parent c44ce89 commit 2e890c4
Showing 1 changed file with 26 additions and 17 deletions.
43 changes: 26 additions & 17 deletions README.rst
Expand Up @@ -11,35 +11,44 @@ IDA Plugins & IDAPython Scripting Library.
For documentation, see `sark.rtfd.io <http://sark.rtfd.io/>`_.


Dependencies
------------
Installation (Python 3 & IDA 7.4)
---------------------------------

1. `NetworkX <https://networkx.github.io/>`_
2. `AwesomeLib <https://github.com/tmr232/awesomelib>`_
3. `wrapt <https://pypi.python.org/pypi/wrapt>`_
4. `idacute <https://github.com/tmr232/cute>`_
For latest version (IDA7.4 & Python3):

.. code:: bash
pip3 install -U git+https://github.com/tmr232/Sark.git#egg=Sark
For more info see `here <http://sark.readthedocs.org/en/latest/Installation.html>`_.

Installation
------------

For latest version:
Python 2 & IDA < 7.4
~~~~~~~~~~~~~~~~~~~~

As of the release of IDA 7.4, Sark is only actively developed for IDA7.4 or
newer, and Python 3.

Python2 and older IDA is still supported for bugfixes & community contributions and
is maintained on the `IDA-6.x branch <https://github.com/tmr232/Sark/tree/IDA-6.x>`_.

To install Sark for older IDA use:

.. code:: bash
pip install -U git+https://github.com/tmr232/Sark.git#egg=Sark
pip2 install -U git+https://github.com/tmr232/Sark.git@IDA-6.x#egg=Sark
Dependencies
------------

For more info see `here <http://sark.readthedocs.org/en/latest/Installation.html>`_.
1. `NetworkX <https://networkx.github.io/>`_
2. `wrapt <https://pypi.python.org/pypi/wrapt>`_

Plugins
-------

Plugin `documentation <http://sark.readthedocs.org/en/latest/plugins/index.html>`_
and `installation instructions <http://sark.readthedocs.org/en/latest/plugins/installation.html>`_.


Other Useful Plugins
--------------------

1. `IDA IPython <https://github.com/james91b/ida_ipython>`_ - Run IPython inside IDA.

0 comments on commit 2e890c4

Please sign in to comment.