summaryrefslogtreecommitdiff
path: root/README.md
blob: cc46953216af987eede5858e5c7aaa44fd0f2913 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Cross-referencing code and requirement
---

Example for generating identifier for requirements from user stories:

```bash
# Try to delete ./example/srs_with_id.txt and then run this command
python ./src/storode.py ./example/srs.txt
```

Example for generating web pages:

```bash
# Try to delete ./doc and run this command
python ./src/storode.py ./example/srs_with_id.txt ./example/src
```

A cross-referencing document will be generated at
./doc/example-srs_with_id.html.  Open example-srs_with_id.html in a
web browser to view it.

Example for testing collision rate of cut of MD5 digest:

```bash
python ./src/collision.py
```