Commit Graph

35 Commits

Author SHA1 Message Date
Moritz
6c6062d5a8 Update usage.md 2020-09-15 10:31:08 +02:00
Moritz
01e8b198c0 Update installation.md 2020-09-15 10:13:41 +02:00
mike-hunhoff
b64ad56caa Merge pull request #310 from fireeye/ida_plugin_documentation
ida plugin: update documentation
2020-09-14 12:48:47 -06:00
Willi Ballenthin
8510f04651 Merge pull request #294 from fireeye/fix-293
docs: installation: clarify when to use method 2
2020-09-11 20:43:41 -06:00
Michael Hunhoff
ffae162955 updating plugin documentation 2020-09-11 17:05:24 -06:00
Michael Hunhoff
7846ffa818 updating ida plugin documentation 2020-09-11 13:15:32 -06:00
Michael Hunhoff
1cb45f35be rename ida plugin 2020-09-11 13:12:28 -06:00
Willi Ballenthin
2c6e244b3c docs: installation: clarify when to use method 2 2020-09-07 10:55:55 -06:00
Michael Hunhoff
e18eb5f463 addressing PR comments 2020-08-31 15:42:44 -06:00
Michael Hunhoff
96eaf311d0 adding support to run explorer as IDA plugin 2020-08-28 17:38:13 -06:00
Ana María Martínez Gómez
f9abbbe9ba hooks: change from post- to pre-commit
Avoid erroneous commits. The pre-commit can be skipped with the
`--no-verify` option, which is not available with the post-commit.
Note that `pre-commit` doesn't run when rebase while post-commit did.

This allows to have a single script which is run by both hooks. This
scripts can also be used independently to run the CI setup locally.
2020-07-29 20:25:03 +02:00
Jordan
508ebb47e0 submodule update requires --init the first time 2020-07-25 17:50:15 -04:00
Ana María Martínez Gómez
0665873b00 doc: Improve cloning capa source code documentation
Move the cloning all submodule option to the beginning as when using
capa in development this is the most common option. Test files are
needed to run the tests locally. Simplify the rest of the submodules
documentation, as it is easier for people to look the submodule
documentation than for us to maintain a copy. The submodule init step
shouldn't be needed to clone the rules directory.
2020-07-24 10:24:34 +02:00
Ana María Martínez Gómez
aa2eb7771c doc: Document supported Linux distributions
Document for which Linux distributions the standalone Linux binary
works.
2020-07-24 10:24:31 +02:00
Ana María Martínez Gómez
7d58d3244c setup: Add vivisect installation to setup.py
Vivisect is not available on PyPI. Tell `pip` in `setup.py` where to
find it so that it is not needed to do it as a separate step.
2020-07-20 22:19:31 +02:00
Jordan Wiens
2a7d4e7fca add explanation to documentation about bypassing gatekeeper 2020-07-17 14:41:17 -04:00
Ana María Martínez Gómez
07764fb31f Use isort 5
Run `isort --profile black --length-sort --line-width 120 .`

Update documentation as well.
2020-07-16 22:02:53 +02:00
Willi Ballenthin
41d6bdc25e installation: note that method 2 doesn't fetch rules 2020-07-14 14:30:32 -06:00
Willi Ballenthin
a297f8f6a0 usage: remove rule generator references and add installation instructions for the explorer 2020-07-14 11:08:41 -06:00
Moritz Raabe
bebc9b0c4f doc: update usage information 2020-07-12 13:22:07 +02:00
Moritz
3ce01fa01b Update usage.md 2020-07-12 13:07:26 +02:00
Moritz
e8195af73e Update limitations.md 2020-07-12 12:26:31 +02:00
Moritz
3744bd6953 Update installation.md 2020-07-11 15:31:07 +02:00
Willi Ballenthin
ea39379ec8 installation: list development setup 2020-07-06 14:21:57 -06:00
Moritz
4f6bf0675c Merge pull request #90 from fireeye/ana-doc-dev
Document how to install development dependencies
2020-07-06 11:34:24 +02:00
Willi Ballenthin
0692e940e9 usage: more words 2020-07-05 14:29:17 -06:00
Ana María Martínez Gómez
26d2f12038 Add Python3 requirement for black
When installing the development dependencies with Python2, it fails as
black is not available for Python2.
2020-07-03 11:38:21 +02:00
Ana María Martínez Gómez
2f78c681e4 Document how to install development dependencies
Introduced in:
d1dd997b7b
2020-07-03 11:30:39 +02:00
Willi Ballenthin
f4cb8cc5b5 installation: wording 2020-07-03 11:41:48 -06:00
Michael Hunhoff
b505197af1 documentation changes 2020-06-24 15:03:21 -06:00
Moritz Raabe
730f0b21fe document -t (tag) option 2020-06-24 13:23:46 +02:00
Willi Ballenthin
fa9bb946ed Merge pull request #1 from fireeye/ana-hooks
Add hooks for running linters and tests
2020-06-22 09:42:07 -06:00
Moritz Raabe
b466087c97 add submodule doc 2020-06-22 12:48:53 +02:00
Ana María Martínez Gómez
96ad823e35 Add hooks for running linters and tests
Add the `scripts/setup-hooks.sh` script which sets the following hooks
up:
- The `post-commit` hook runs the linter after every `git commit`,
  letting you know if there are code style or rule linter offenses you
  need to fix.
- The `pre-push` hook runs the linter and the tests and block the `git
  push` if they do not succeed.
  This way you realise if everything is alright without the need of
  sending a PR.
2020-06-22 11:35:45 +02:00
William Ballenthin
add3537447 import source files, forgetting about 938 prior commits 2020-06-18 09:13:19 -06:00