From 6e95aeb154dc56b445371255104097aba89a94cd Mon Sep 17 00:00:00 2001 From: oliver Date: Mon, 26 Aug 2024 01:09:46 -0600 Subject: [PATCH] install instructions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index f86dfdc..3b7be26 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,12 @@ Mapping with a budget of 1000 (crawl 1000 sites, so many more links are actually This is including the crawl and loading into the database and linking sites. (Locally hosted surreal db instance) This run created 4299 site links with 23286 links between the sites. (It found my this git site which really bolsters those numbers.) + +# Use / Install + +* You will need rust to compile the crawler [rustup.rs](https://rustup.rs) + +* You need python3 (will come installed on most linux distros) and poetry for dependancy management. + * Install `pipx`, `python3` + * Then: `pipx install poetry` + * Then: `poetry install` to install the project dependancies