Skip to content

Commit 76190b3

Browse files
committed
update README
1 parent b95ba6a commit 76190b3

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -89,42 +89,46 @@ True
8989
00000000: 01 00 00 70 ...p
9090
```
9191

92-
## Installation
92+
## Installing
9393

94-
Download the `dncil` source and run the following command from the root directory:
94+
To install `dncil` use `pip` to fetch the `dncil` module:
9595

9696
```
97-
$ pip install .
97+
$ pip install dncil
9898
```
9999

100-
To execute the example scripts be sure to install [`dnfile`](https://github.com/malwarefrank/dnfile). Alternatively, install `dncil` with the development dependencies as described in the `Testing` section below.
100+
To execute the example scripts be sure to install [`dnfile`](https://github.com/malwarefrank/dnfile). Alternatively, install `dncil` with the development dependencies as described in the `Development` section below.
101101

102102
See [print_cil_from_bytes.py](scripts/print_cil_from_bytes.py) for a quick example of using `dncil`to print the `CIL` instructions found in a byte stream containing a `.NET` managed method.
103103

104-
## Testing
104+
## Development
105105

106-
Ensure you have installed `dncil` with the development dependencies:
106+
If you'd like to review and modify `dncil` source code, you'll need to download it from GitHub and install it locally.
107+
108+
Use the following command to install `dncil` locally with development dependencies:
107109

108110
```
109-
$ pip install .[dev]
111+
$ pip install /local/path/to/src[dev]
110112
```
111113

112-
Then invoke pytest:
114+
You'll need `dncil`'s development dependencies to run tests and linting as described below.
115+
116+
### Testing
117+
118+
Use the following command to run tests:
113119

114120
```
115-
$ python -m pytest tests/
121+
$ pytest /local/path/to/src/tests
116122
```
117123

118-
## Linting
119-
120-
Ensure you have installed `dncil` with the development dependencies as described above.
124+
### Linting
121125

122-
Then:
126+
Use the following commands to identify format errors:
123127

124128
```
125-
$ pycodestyle --show-source dncil tests
126-
$ python -m black -l 120 -c .
127-
$ python -m isort --profile black --length-sort --line-width 120 -c .
129+
$ pycodestyle --show-source /local/path/to/src/dncil /local/path/to/src/tests
130+
$ black -l 120 -c /local/path/to/src
131+
$ isort --profile black --length-sort --line-width 120 -c /local/path/to/src
128132
```
129133

130134
## Credits

0 commit comments

Comments
 (0)