diff --git a/README.md b/README.md index 1277f60..0fab51f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,25 @@ -# Force Graph +# Graph Force A python/rust library for embedding graphs in 2D space, using force-directed layouts. +## Development + +### Setup +``` +python3 -m venv venv +source venv/bin/activate +pip install -r requirements.txt +``` + +### Build +``` +maturin develop +``` + +## Usage +```python +import graph_force + +edges = [(0, 1), (1, 2), (2, 3), (3, 0)] +pos = graph_force.layout_from_edge_list(4, edges) +``` \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6fdfcae --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +maturin==0.14.1