added FAQ and Contribs

This commit is contained in:
EntireTwix 2021-06-06 17:31:45 -07:00
parent 037bb2ea4d
commit 1e7203db9b

View file

@ -13,7 +13,9 @@ the currency model most Minecraft Servers adopt if any, is resource based, usual
CCash solves these issues and adds a level of abstraction, the main philosophy of CCash is to have fast core operations that other services build on
## Build
drogon depedencies
```
sudo apt install libjsoncpp-dev
sudo apt install uuid-dev
@ -21,7 +23,9 @@ sudo apt install openssl
sudo apt install libssl-dev
sudo apt install zlib1g-dev
```
building the project
```
git clone --recurse-submodule https://github.com/EntireTwix/CCash/
mkdir build
@ -29,11 +33,15 @@ cd build
cmake ..
make -j<threads>
```
then edit config.json to include the paths to your certs for HTTPS (I use certbot), or just remove the listener for port 443.
```
vim ../config.json
```
finally, run the program
```
sudo ./bank <admin password> <saving frequency in minutes> <threads>
```
@ -68,6 +76,14 @@ Go to `{ip}/BankF/help` to see the bank's methods (also found in releases as hel
`**WARNING** : abruptly killing the program will result in data loss, use Close() method to close safely`
## FAQ
some frequently asked questions are
## Contributions
[Doggo](https://github.com/FearlessDoggo21) Logs Optimized
## Features
### Performance