Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sthalik authored Aug 11, 2024
1 parent af26500 commit 04c4222
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,29 @@
[![commit](https://github.com/sthalik/floormat/actions/workflows/cmake.yml/badge.svg)](https://github.com/sthalik/floormat/actions/workflows/cmake.yml)

### floormat
# floormat

Game project in early development.

### Build
## Build

Should build cleanly on Clang 17+, GCC 13.2+ and MSVC 17.7. Just make sure to check it out with submodules.
Should build cleanly on Clang 17+, GCC 13.2+ and MSVC 17.7+.

### License
### Debian/Ubuntu dependencies
`xorg-dev` `libsdl2-dev` `build-essential` `ninja-build` `cmake-curses-gui`

ISC
### Windows dependencies

Only the compiler (MSVC, GCC, Clang) is needed.

### Building
```console
git clone https://github.com/sthalik/floormat.git
cd floormat
git submodule update --init
mkdir build
cd build
cmake -GNinja ../
ninja install
ln -s ../doc/saves ./save
install/bin/floormat-editor
```

0 comments on commit 04c4222

Please sign in to comment.