From 0f3f50b858efefbc35e20015adcd7345eaf496c6 Mon Sep 17 00:00:00 2001 From: Julian Hurst Date: Sun, 8 Sep 2024 04:18:41 +0200 Subject: Add readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..03402b4 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# docspace + +A server for hosting files for different users. + +## Build + +To build, install go and a gcc compiler and run: + + CGO_ENABLED=1 go build + +If you're using musl instead of glibc: + + CGO_ENABLED=1 CGO_CFLAGS="-D_LARGEFILE64_SOURCE" go build + +## Usage + + Usage of ./docspace: + -d string + the db to connect to (default "./db/test.db") + -f string + the path of the docs folder (default "docs") + -p int + the port to bind to (default 8080) -- cgit v1.2.3