From 3044b87dec50a7ea11a07062889af3b66f532c56 Mon Sep 17 00:00:00 2001 From: NaiJi Date: Tue, 18 Oct 2022 07:01:01 +0400 Subject: [PATCH] docs: Add brand new README --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e06c349 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# project-kyoku + +I am just trying to create a rhythm game inspired by project-diva + +### Initial setup + +- Make sure you have a compiler supporting c++17 and cmake +- Make sure you have [sfml](https://www.sfml-dev.org/) installed, either static or not, just make sure to edit impl/ CMake file, you'll see it. +- Now clone it +``` +git clone https://dev.udongein.xyz/NaiJi/project-kyoku +``` + +- Go to the project folder +``` +cd project-kyoku/ +``` + +- Now build it! +``` +cmake CMakeLists.txt -B ./build +cd ./build +make +``` + +### Conventional commits + +This project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). + +`(optional scope): ` + +Example: `feat(classic-mode): Implement something great`