Skip to content

Commit 9b60f28

Browse files
committed
Updatign readme
1 parent 74c02cb commit 9b60f28

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,46 @@ If a density matrix ρ has high fidelity (> 1-δ) with a pure state, then its vo
1414
S(ρ) ≤ -(1-δ) log(1-δ) - δ log(δ/(R-1))
1515
```
1616

17-
## Building
17+
## Building the Project
1818

1919
```bash
2020
lake update
2121
lake exe cache get
2222
lake build
2323
```
2424

25-
## Blueprint
25+
## Blueprint Documentation
2626

27-
Generate the documentation:
27+
**Prerequisites:**
28+
- Python ≥ 3.7
29+
- Graphviz:
30+
- macOS: `brew install graphviz`
31+
- Linux: `sudo apt-get install graphviz graphviz-dev`
2832

29-
```bash
30-
cd blueprint
31-
leanblueprint web
32-
open web/index.html
33-
```
33+
**Setup:**
34+
35+
1. Install leanblueprint:
36+
```bash
37+
pip install leanblueprint
38+
```
39+
40+
2. If installation fails with `pygraphviz` errors on macOS:
41+
```bash
42+
pip install --config-settings="--global-option=build_ext" \
43+
--config-settings="--global-option=-I$(brew --prefix graphviz)/include" \
44+
--config-settings="--global-option=-L$(brew --prefix graphviz)/lib" \
45+
pygraphviz
46+
pip install leanblueprint
47+
```
48+
49+
3. Generate the blueprint:
50+
```bash
51+
cd blueprint
52+
leanblueprint web
53+
```
54+
55+
The blueprint will be at `blueprint/web/index.html`.
56+
57+
## License
3458

59+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)