Skip to content

Commit 689f029

Browse files
committed
Make .#testing the default shell, update README
1 parent 322d320 commit 689f029

File tree

2 files changed

+27
-10
lines changed

2 files changed

+27
-10
lines changed

README.md

+26-9
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ via a browser based rich user interface.
1111

1212
## Install
1313

14-
cozy is now available as a Python package on PyPI under the name `cozy-re`. Install with pip via the following command:
14+
cozy is now available as a Python package on PyPI under the name `cozy-re`.
15+
Install with pip via the following command:
1516

1617
```commandline
1718
pip install cozy-re
@@ -25,19 +26,25 @@ https://draperlaboratory.github.io/cozy/
2526

2627
## Template Generator
2728

28-
cozy now comes with a Python script template generator to help you get started with using the framework. The wizard will prompt you with a series of questions and generate the appropriate file with starter code. To run the generator, install cozy, then run the following command in the console:
29+
cozy now comes with a Python script template generator to help you get started
30+
with using the framework. The wizard will prompt you with a series of questions
31+
and generate the appropriate file with starter code. To run the generator,
32+
install cozy, then run the following command in the console:
2933

3034
```commandline
3135
python3 -m cozy
3236
```
3337

3438
## About
3539

36-
cozy is being developed by Draper Laboratory under the [DARPA Assured Micropatching (AMP) program](https://www.darpa.mil/program/assured-micropatching).
40+
cozy is being developed by Draper Laboratory under the [DARPA Assured
41+
Micropatching (AMP)
42+
program](https://www.darpa.mil/program/assured-micropatching).
3743

3844
## Build Instructions
3945

40-
To get started with building cozy, run the following commands in the project root folder to create a virtual environment and install angr:
46+
To get started with building cozy, run the following commands in the project
47+
root folder to create a virtual environment and install angr:
4148

4249
```commandline
4350
python3 -m venv venv
@@ -47,16 +54,17 @@ pip3 install angr sphinx sphinx-autoapi networkx claripy portion
4754

4855
Alternatively, if you have `nix` installed and flakes enabled, run
4956

50-
```
51-
nix develop .#testing
57+
```commandline
58+
nix develop
5259
```
5360

5461
To enter a nix development shell with `cozy` and its dependencies available on
5562
`$PYTHONPATH`.
5663

5764
## Testing
5865

59-
To run an example comparison, run one of the example scripts. In the root directory, run the following commands:
66+
To run an example comparison, run one of the example scripts. In the root
67+
directory, run the following commands:
6068

6169
```commandline
6270
source venv/bin/activate
@@ -67,14 +75,23 @@ python3 examples/cmp_null_deref.py
6775
Or just `python3 examples/cmp_null_deref.py` if you're in the nix development
6876
shell.
6977

78+
If nix is available, then to run the full suite of tests used in CI, you can
79+
run:
80+
81+
```commandline
82+
nix build .#tests
83+
```
84+
7085
### Building Docs
7186

72-
Building the docs requires the use of sphinx and sphinx-autoapi, which you should have previously installed via pip3. To build fresh HTML docs, run the following:
87+
Building the docs requires the use of sphinx and sphinx-autoapi, which you
88+
should have previously installed via pip3. To build fresh HTML docs, run the
89+
following:
7390

7491
```commandline
7592
source venv/bin/activate
7693
cd docs
7794
make html
7895
```
7996

80-
The output documents should be stored in docs/build/html
97+
The output documents should be stored in docs/build/html

flake.nix

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
'';
7979
};
8080

81-
devShells.x86_64-linux.testing = pkgs.mkShell {
81+
devShells.x86_64-linux.default = pkgs.mkShell {
8282
shellHook = ''
8383
export PYTHONPATH="$(git rev-parse --show-toplevel)":$PYTHONPATH
8484
'';

0 commit comments

Comments
 (0)