From 0d419d64060b8f32e543e0745b9c3d5e9da009e1 Mon Sep 17 00:00:00 2001 From: Odweta Date: Mon, 25 Dec 2023 23:35:22 +0100 Subject: [PATCH] Update README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc03bad --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Vendetta + +A manager/creator for projects that make use of the OdwetaLibC library + +It creates a project structure that can be seen in `/example_project/`. + +## Conventions + +Vendetta uses **git** as the version control system and **make** as the build system which uses **gcc** to compile all the glorious C code your project has to offer. Let's say the root of your project directory is `/`. Then all of your source files go in `/src/`, all of your includes go in `/include/`. And that's all you need to know, I guess. Just submit an issue when you don't know what to do... All your Makefiles, .gits, READMEs, LICENSEs and stuff like that are in `/`. + +## Installation + +`make install` + +## Create a project + +`vendetta new ` + +## Build a project + +`vendetta build ` + +## Build and run a project + +`vendetta run `