Skip to content

Commit 5935d1a

Browse files
authored
Update README.md for poetry getting started
1 parent 82c1972 commit 5935d1a

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,34 @@ still in play at the moment and this is not a final specification or implementat
1313

1414
This project uses `poetry` for the python build system.
1515

16-
Table Of Contents:
16+
Table Of Contents:pipx
1717
* [Application Interface](#Application-Interface)
1818
* [Programming Interfaces](#Programming-Interfaces)
1919
* [Command-line Examples](#Examples)
2020
* [FLIC Manifests](#FLIC-Manifests)
2121
* [Implementation Notes and dependencies](#Implementation-Notes)
2222

2323
# Usage
24+
25+
## Getting Started with Poetry
26+
27+
Make sure poetry is installed and version 2.1.1 or later. See https://python-poetry.org/docs/.
28+
29+
```bash
30+
poetry update
31+
poetry build
32+
make check
33+
```
34+
35+
You should see all the unit tests pass.
36+
37+
```bash
38+
poetry run manifest_writer --help
39+
```
40+
41+
This command should display the help menu from the ccnpy command. It may also display some warnings about pyproject.toml. If you see the help menu, you are ready to proceed.
42+
43+
2444
## Application Interface
2545

2646
* ccnpy.apps.manifest_writer: slice up a file into nameless data content objects and organize them into a manifest tree.

0 commit comments

Comments
 (0)