From 8e1b99a161c359a942721ef900f13d05ba96843d Mon Sep 17 00:00:00 2001
From: Alex <caskd@420blaze.it>
Date: Sun, 5 Jul 2020 13:10:50 +0200
Subject: [PATCH] Add readme, remove test code

---
 README.md  | 39 +++++++++++++++++++++++++++++++++++++++
 src/main.c | 14 --------------
 2 files changed, 39 insertions(+), 14 deletions(-)
 create mode 100644 README.md
 delete mode 100644 src/main.c

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..daab2e3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# MicroIRC, a simple, lightweight IRC protocol helper
+
+## Requirements
+
+- CMake (tested on 3.17)
+- Standard UNIX library
+- C99+ compiler
+
+## Building
+
+First, create the required build files (usually the Makefile)
+```sh
+cmake . -DUSE_HELPERS=1 -DCMAKE_BUILD_TYPE=Release
+```
+Note: You can omit USE_HELPERS if you do not plan to use them.
+
+Following that, just use your build system and compile it
+
+Example for **make**:
+```sh
+make
+```
+
+You now should have the library built at `build/lib/libuirc.so`
+
+## License
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
diff --git a/src/main.c b/src/main.c
deleted file mode 100644
index 4a810c6..0000000
--- a/src/main.c
+++ /dev/null
@@ -1,14 +0,0 @@
-#ifndef UIRC_HELPERS
-#define UIRC_HELPERS
-#endif
-#include "../include/uirc.h"
-#include <stdio.h>
-#include <stdlib.h>
-
-int main(int argc, char* argv[])
-{
-	char out[513] = {0};
-	uirc_assm_mesg(out, Assemble_PING(NULL, "ok"));
-	printf("Output: %s\n", out);
-	return EXIT_SUCCESS;
-}