diff --git a/README.md b/README.md index c51fa78..f4c2548 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ -# FileHosting +# TNC File Hosting -The Night Club's very own basic image hosting web frontend. \ No newline at end of file +The Night Club's very own basic image hosting web frontend. + +# Building + +1. To build the project you must install the header-only (a.k.a not-boost version) of ASIO. + +(in debian-based systems run ``# apt install libasio-dev``) + +2. make ``build/`` directory inside the repo +3. run ``$ cmake ..`` +4. lastly run ``$ make`` + +You can run ``./Webserver`` to run the server fully.