docs: Add makefile documentation + main.c cleanup

.gitignore

@@ -0,0 +1 @@
+tmp/**/*

makefile

@@ -1,31 +1,41 @@
+# C compiler to use
 CC := gcc
 
+# Directory mappings
 SRC_DIR := src
 LIB_DIR := lib
 OBJ_DIR := obj
 OUT_DIR := out
 INC_DIR := include
+
+# Map all object and source files
 SRC_FILES := $(wildcard $(SRC_DIR)/*.c) $(wildcard $(LIB_DIR)/*.c)
 OBJ_FILES := $(patsubst $(SRC_DIR)/%.c,$(OBJ_DIR)/%.o,$(SRC_FILES))
 
+# All optional libs and Cflags to append to the final command
 LIBS := $(mysql_config --libs) $(mysql_config --cflags) -lmysqlclient
 CFLAGS := -I$(INC_DIR)
 
-dev: $(OBJ_FILES)
-	$(CC) -o $(OUT_DIR)/$@ $^ $(CFLAGS) $(LIBS) && strace ./out/dev
-
-run: $(OBJ_FILES)
-	$(CC) -o $(OUT_DIR)/$@ $^ $(CFLAGS) $(LIBS) && ./out/run
-
-prod: $(OBJ_FILES)
-	$(CC) -o $(OUT_DIR)/$@ $^ $(CFLAGS) $(LIBS)
-
+# Special and default commands
+.PHONY: clean help
+.DEFAULT_GOAL := help
 
+# Macro for creating object files
 $(OBJ_DIR)/%.o: $(SRC_DIR)/%.c
 	$(CC) -c -o $@ $<
 
-.PHONY: clean
+## All make commands ##
+help: ## Lists all commands
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-clean:
-# rm -f $(OBJ_DIR)/*.o *~ core $(INC_DIR)/*~
-	rm -f $(OBJ_DIR)/*.o $(OUT_DIR)/*
+clean: ## Clean up all object files and executables
+	rm -f $(OBJ_DIR)/*.o $(OUT_DIR)/*
+
+dev: $(OBJ_FILES) ## Build, run and debug the project
+	$(CC) -o $(OUT_DIR)/$@ $^ $(CFLAGS) $(LIBS) && strace ./out/dev
+
+run: $(OBJ_FILES) ## Build and run the project
+	$(CC) -o $(OUT_DIR)/$@ $^ $(CFLAGS) $(LIBS) && ./out/run
+
+prod: $(OBJ_FILES) ## Build the project
+	$(CC) -o $(OUT_DIR)/$@ $^ $(CFLAGS) $(LIBS)

src/main.c

@@ -1,8 +1,4 @@
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <stdbool.h>
-
+/* main.c */
 #include "../include/database.h"
 #include "../include/choicemenu.h"
 
@@ -22,6 +18,5 @@ extern char _database[56];
 
 void main() {
   init_mysql();
-
   choice_menu();
 }

tmp/pgp.txt

@@ -1,52 +0,0 @@
------BEGIN PGP PUBLIC KEY BLOCK-----
-
-mQINBGM8PhQBEADpxu2OQZK3QYJWvvS0OWlpJb+hsjB+bDslHiuurjeFH2+LYCk9
-Q0rOiIJAZDxaTFgFuBCasdWeCgRVyZVwrCyXjhr/mahJL9yO0+/v9XQmRL8HD6DZ
-rsl8a4weI83sFQJCl0zn1toZN5YWIWSo3PM4wwaaAFhDEWK22mNR2b/xwzZb96G2
-EvIh0xU62/jJJkvPAhqrzqj0ECKT8xWAKpc6/NC9sQLM18i3OSGbcARxnxD4XzHf
-8wd2bFmk8rB7tW3sEcH2cXrj1Zv3e4g2JFZzyhdlq8liPTzTlOrb4ec9fmZhuD8n
-EmHSr2L61FrY/7FiotWslxBmn5f7n3wM7zQmflBvcgDFYh0RWnc2+GqWQ60+V7Qf
-T8uLXZ7UZRaNmk+LdSeZZC5IuM+kL9FP82YZvNum3I2/pTiP007Uy6s4drWr2RU9
-SG8qRPId7BWXXAdZp/6yvQI1d9XTCXu13iJ0Krbb8LGIqWY2s1djFnrmgCGyWUiG
-8+LU76bMw5jraLrPqblT1fAeLzfF1KOqXt2hR9Tq1PPPmK2nF2HnXWmFoC+VU+m0
-XVtpgLBNcTkKa9mUw9ZjXo4SC3SVWEFrViB2w/5RsMj8fVVTje9WgawsXLDne24i
-6sEJp+W4K7bu1KL/OERY1cE0MpXFW8xEVJ7YSjoNG9qCUYB8Ec8bTIfbywARAQAB
-tC1XZXNzZWwgVGlwIChHaXRIdWIgR1BHIEtleSkgPHdlc3NlbEBnbzJpdC5ldT6J
-Ak4EEwEIADgWIQS0jePMDZqLKt2kFQ2rb8DBGNeSFAUCYzw+FAIbAwULCQgHAgYV
-CgkICwIEFgIDAQIeAQIXgAAKCRCrb8DBGNeSFO/xD/9WsMnh4nqTOw+kvUuI0P36
-FOpoYjl3RMHPaJEwAhfJk6/C15xQv9RCzaMQ+wgbmr52Kyr4kiX4D2AU1IJclIH9
-UE2RFhZ3BlwGkYWvzJ+Q24/jMH5eSu1RlTjBC+Dd4aVqliqPCn9Ia4uXV9kBHkBD
-T4NQd7JjgL1xlsXAN4cYgtXX6YKTxrfhr2+MTsdjUgduvfnr4SgLV7NFjtBZYliY
-/ufoVzsXqMpPD1oO2CiTmW4mlak6Ee5QmAL0mzHXNIXorH6c0OMUZ5glYVxWsTYq
-HTmRcqVi4qo/RxHxSZVZCQaYFIfuXsin5+9dGKXsfq67muZ4xTGTQP83vFZ09VOm
-coinovsE4NO4MGyJDXnnjGOWzucVcnPtU+490427v6EH9W/PfSU6DV1L6n4NZbSb
-jENSWtWnteRnW/M2TIDi6eei64jA3MLZzNk9kPirEWzd++M7Ol4RNKKPUQci0ov3
-MBRxsbw5+D3spEuFpPDJ1R3tyFe5UgQu0gM++WNtXuT/JIAv/XKKwaIEUFKSUhMt
-omcLtShtob6Yn/5IwXn6zJyO0xjW1JdF3k1eQcjihoF4OetA6O9FNB7GVXJQcf12
-o/xilPqEzkjRtFeXfe8Lm11BHtIwTTFQe359eWkR50+15lRIfJJcdUtGUfEvssZd
-DJGSiRvYMDpv5zhB4wTxb7kCDQRjPD4UARAAuWwvgUgelReUc2i82NG7uqe7LjG/
-8YrR0GDoe4j0MEsFCBq7tK3TCcKFmCPhKkqbwBrM3sXNQNVRhwzDva2jh0kbwB56
-S323vyVBA1zTtbp7773PyhE3CIGdU8L1d+/4Ua3rnghM+mzI2GrBZ3PF8vKMgWqU
-nJpsg2+EPBENB5y/7loPNAX96f3iSirahnQ1CwOnXMdjroI+ZJo6nL542kJ0p4K7
-fNRlBoEXpmVrVCmQz6ZB2/HbJK7q6URd9WE4ArmDpowp2ryv8bvwWWdj68fbNJ2T
-GIi+Kcvq+VlUmTs//rQV3DOx4WD+HZ5IhRm7MGyomO3S9gKM9pwkAzSyrGxYpBOc
-lSQU8oyRfdak0820W49/9xt/QosaRlCpsIE+jvSSsHzfAEG+zpJHUtSx5h1AIG8J
-mreWDtP7CPfMrUA2FiJy4Qo2Z/aK0GbCWdnKtX9ROOL5bwS0m9jj+wB86Inuk8dU
-CZ0w2SlukfIwa8dXQWNOZ99JYlRJvmOssQn6BwChpfSf23YuZj7Awlus623kURtI
-oLcvIYSkfnBvDdgwElKe94e4eCup+Q3EUFsFq/Cew+WBFw6eXeHErbV27AoS4Ywo
-5PdMIfWpADlXKlgQtXbyrRrNoW2ThJvxXQmZQOGATCEURnbQ6ddNKa5bAUQgFw99
-SYsPS1+U6qRpicUAEQEAAYkCNgQYAQgAIBYhBLSN48wNmosq3aQVDatvwMEY15IU
-BQJjPD4UAhsMAAoJEKtvwMEY15IU7cgQAM5f9bl3/X7NY2dZold2kW+oWMVLFvN6
-vTrF0MCneuNZtC+AwdYE/dNTBWwiBmzSUPK7W/lCuXLdBYC5ZkPmPPccucPIoGNX
-vWbUo9gluYA/5oCl61a5r2HH9aoSCnMnoRrq8asHH4W/Yz3kXoawp/TsA876iGNk
-t8mNwgiO9Du2J4LSSFCDeYhj2KYXKaOkRoB6T26kpZIhwS/q4RNKk0BttXWCqHQ3
-++l+4uS7TV/a4K79iQUpdU1qK58PCyP4iTRlT0Dm1tT53D6g1bo1CEAbWnzNKAEQ
-J1vwy6waLK0udqZ/thcskapCvGa9As1G3uzJJsMdWu7nSoeYlUeZkzkkm98DIvIS
-XOnqoxO18SQ6HTvO1J04R8iu245NfNlcPczeg/D+qXiV761fyHAlXABNRjkZj7qv
-kqdr0netw4j6MNcT081xbaE3Br9uAQRio5/IMDYGNUtsqaR+q1QrFf+vFdrTL2Tx
-BuBFwaqdRMB3J6hMsRN8K3L2YUkKYSewGM2FPBA2yZCrVCFiFxuAo0IVaay8aohQ
-aHm0qBW6ZH3zaCJq+G8laXo/4ApoiHPh/mdE7QXurwdCSFJW/5ltpbYupSRduIxA
-K1p4h13Mg9UlTTPYJySaGZrrz4IzbQ6VvC2HawD8AQaDXwzcaxwbX5zxR/dv/Xt3
-sPNV9V2sEQBi
-=LKWP
------END PGP PUBLIC KEY BLOCK-----