docs: Add brand new README
This commit is contained in:
parent
d6818bbd2f
commit
04a952ab22
|
@ -0,0 +1,31 @@
|
|||
# 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/).
|
||||
|
||||
`<type>(optional scope): <description>`
|
||||
Example: `feat(classic-mode): Implement something great`
|
Loading…
Reference in New Issue