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
