From ccc88d088865952b488eb3282531a48e8e5aae4a Mon Sep 17 00:00:00 2001
From: Ruben Dahl <dahrub@nxi.no>
Date: Sun, 15 Jan 2023 19:40:08 +0100
Subject: [PATCH] Added documentation for the language source.

---
 src/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 src/README.md

diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..229d58f
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,28 @@
+# CeeVLang Documentation
+
+## Includes
+
+```cpp
+#include "colors.h"
+#include <deque>
+#include <filesystem>
+#include <fstream>
+#include <iostream>
+#include <map>
+#include <sstream>
+#include <string>
+```
+
+## Functions
+
+```cpp
+int read_file(std::deque<std::string> args);
+```
+Param: std::deque\<std::string\> args - The arguments from main() in ceev.cc, with used
+values stripped out.
+
+Returns: int exit_code
+
+Reads the file and outputs it.
+
+Currently a work in progress.