rebase hell is over + some tweaks to README.md
This commit is contained in:
20
README.md
20
README.md
@@ -1,15 +1,7 @@
|
|||||||
# TNC File Hosting
|
# TNC File Hoster
|
||||||
|
|
||||||
The Night Club's very own basic image hosting web frontend.
|
The Night Club's very own basic image hosting web frontend.
|
||||||
|
|
||||||
# Coing Guidelines
|
|
||||||
|
|
||||||
- In most of my projects I have less header(h/hpp) files than implementation files(c/cpp). This is very much intentional. I implement parts of a header file for ease of reading. You are expected to NOT make 1 header per 1 implementation file!!!
|
|
||||||
|
|
||||||
- When doing ``#include`` if the same include is used more than once in different implementation files that share a header file. Move the ``#include`` to the header file instead of having two of the same includes.
|
|
||||||
|
|
||||||
- Codebase must adhere to DRY and KISS (DRY KISS) principles!
|
|
||||||
|
|
||||||
# Building
|
# Building
|
||||||
|
|
||||||
1. To build the project you must install the header-only (a.k.a not-boost version) of ASIO.
|
1. To build the project you must install the header-only (a.k.a not-boost version) of ASIO.
|
||||||
@@ -21,3 +13,13 @@ The Night Club's very own basic image hosting web frontend.
|
|||||||
4. lastly run ``$ make``
|
4. lastly run ``$ make``
|
||||||
|
|
||||||
You can run ``./Webserver`` to run the server fully.
|
You can run ``./Webserver`` to run the server fully.
|
||||||
|
|
||||||
|
|
||||||
|
# Coing Guidelines
|
||||||
|
|
||||||
|
- In most of my projects I have less header(h/hpp) files than implementation files(c/cpp). This is very much intentional. I implement parts of a header file for ease of reading. You are expected to NOT make 1 header per 1 implementation file!!!
|
||||||
|
|
||||||
|
- When doing ``#include`` if the same include is used more than once in different implementation files that share a header file. Move the ``#include`` to the header file instead of having two of the same includes.
|
||||||
|
|
||||||
|
- Codebase must adhere to DRY and KISS (DRY KISS) principles!
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user