Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
necromyhan authored Nov 30, 2023
1 parent 9524f53 commit 4eb5c14
Showing 1 changed file with 34 additions and 6 deletions.
40 changes: 34 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,64 @@
# Snake Game
Simple SDL3 game project written in C99.

## Features

## Build
### Linux

| Required packages|
|------------------|
| build-essential |
| libfreetype6 |
| libfreetype6-dev |
| libsdl2-dev |

1. Install required packages
```bash
sudo apt install build-esseintial libfreetype6 libfreetype6-dev libsdl2-dev
```
\
2. Clone repo form github
```bash
git clone https://github.com/necromyhan/snake-game
```

\
3. Choose project directory
```bash
cd snake-game
```

\
4. Init and update git submodules
```bash
git submodule init
```

```bash
git submodule update
```

\
5. Configure CMake
```bash
cmake -B build
```

\
6. Build project
```bash
cmake --build build
```
\
_Tested on Ubuntu 23.10.1_

### Windows

Same as Linux, but before cmake build download [FreeType](https://sourceforge.net/projects/freetype/) sources and copy them into ___..\Snake-Game\sdl\SDL_ttf\external\freetype directory___.
Same as Linux, but before cmake build download [FreeType](https://sourceforge.net/projects/freetype/) sources and copy them into ___..\Snake-Game\sdl\SDL_ttf\external\freetype___ directory.
\
\
_Tested on Windows 10 22H2_

## Binary

You can download archives with game from Releases section.\
For Linux, self-build is recommended.

## Controls

Expand Down

0 comments on commit 4eb5c14

Please sign in to comment.