gitea-mirror/capa
1
0
Fork 0
mirror of https://github.com/mandiant/capa.git synced 2025-12-05 20:40:05 -08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2 from fireeye/doc/submodule-install

Browse Source 
add submodule doc
This commit is contained in:
Willi Ballenthin
2020-06-22 09:41:29 -06:00
committed by GitHub
parent 60d7c87379 b466087c97
commit 273ca81919
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/installation.md
View File

@@ -28,13 +28,17 @@ First, install the requirements.
`$ pip install https://github.com/williballenthin/vivisect/zipball/master`
### 2. Check out source code
First, clone the capa git repository.
First, clone the capa git repository. We use submodules to separate code, rules, and test data. To get all data at once use the `--recurse-submodules` option shown below. To only get the source code and our provided rules, follow these steps:
- `$ git clone https://github.com/fireeye/capa.git /local/path/to/src` (HTTPS) or `$ git clone git@github.com:fireeye/capa.git /local/path/to/src` (SSH)
- `$ cd /local/path/to/src`
- `$ git submodule init`
- `$ git submodule update rules`
#### SSH
`$ git clone git@github.com:fireeye/capa.git /local/path/to/src`
`$ git clone --recurse-submodules git@github.com:fireeye/capa.git /local/path/to/src`
#### HTTPS
`$ git clone https://github.com/fireeye/capa.git /local/path/to/src`
`$ git clone --recurse-submodules https://github.com/fireeye/capa.git /local/path/to/src`
### 3. Install the local source code
Next, use `pip` to install the source code in "editable" mode. This means that Python will load the capa module from this local directory rather than copying it to `site-packages` or `dist-packages`. This is good, because it is easy for us to modify files and see the effects reflected immediately. But be careful not to remove this directory unless uninstalling capa.