From 0326f6e0fdf063463f42a611d877cccb42ceac6a Mon Sep 17 00:00:00 2001 From: Jef Roosens Date: Sun, 27 Jun 2021 11:15:58 +0200 Subject: [PATCH] Updated README --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7753b10..7491eaa 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # hilde -A server implementation of a Debian repository. \ No newline at end of file +A server implementation of a Debian repository. + +## Development + +To develop this project, you'll need a few things: + +* Docker (for setting up the database) +* Cargo & Rust stable (all hail Rocket v0.5) +* The PostgreSQL dev libraries (to compile Diesel) + +That's the ones I can think of right now. If I think of any others, I'll be +sure to add them to the list. + +For ease of development, there's a Makefile wrapper that can do everything you +need to do to work on Hilde. I recommend reading through it (it's not long), +but the important ones are `make` & `make run`, which are just Cargo aliases, +and `make db`, which starts a local PostgreSQL database using Docker. \ No newline at end of file