Added documentation for the language source.

master
Ruben Dahl 2023-01-15 19:40:08 +01:00
parent 9745e4d63a
commit ccc88d0888
No known key found for this signature in database
GPG Key ID: C7838D0300EDEF1B
1 changed files with 28 additions and 0 deletions

28
src/README.md 100644
View File

@ -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.