From d4c085911547f5a68cceb33f8c138f5d63c07b3b Mon Sep 17 00:00:00 2001 From: Edward Shen Date: Sun, 25 Apr 2021 00:01:20 -0400 Subject: [PATCH] Update build instructions --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9faf7b2..a3f8723 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,16 @@ This client contains the following features: ## Building +Since we use SQLx there are a few things you'll need to do. First, you'll need +to run the init cache script, which initializes the db cache at +`./cache/metadata.sqlite`. Then you'll need to add the location of that to a +`.env` file: + ```sh -cargo build --release +# In the project root +./init_cache.sh +echo "DATABASE_URL=sqlite:./cache/metadata.sqlite" >> .env +cargo build ``` ## Cache implementation