From e1319343564921c0d2c26be7c5b094e3a8035f90 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Tue, 19 Sep 2023 11:51:53 +0200 Subject: [PATCH] Update Readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 69b275a..54b3b2c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ # Init projects! +## C + +Copy and paste [`c/`](./c/) directory, and you should be good to go! + +- Remember to change executable's name in the [`Makefile`](./c/Makefile). +- **Run `make` to compile the program.** +- **Run `make dev` to compile the program in debug mode.** +- **Run `make clean` to clean artifacts.** + +> Note that in headers, the syntax is `PROJETNAME_FILENAME_H` + +## C++ + +Copy and paste [`cpp/`](./cpp/) directory, and you should be good to go! + +- Remember to change executable's name in the [`Makefile`](./cpp/Makefile). +- **Run `make` to compile the program.** +- **Run `make dev` to compile the program in debug mode.** +- **Run `make clean` to clean artifacts.** + +> Note that in headers, the syntax is `PROJETNAME_FILENAME_HPP` + ## Typescript -Copy and paste [`typescript/`](./typescript/) directory and you should be good to go! +Copy and paste [`typescript/`](./typescript/) directory, and you should be good to go! - Remember to change values in the [`package.json`](./typescript/package.json). - Then, to install all the dependencies, run `npm install`.