https://github.com/joellefkowitz/snake
An SDL2 implementation of the classic game Snake.
https://github.com/joellefkowitz/snake
arcade game
Last synced: 24 days ago
JSON representation
An SDL2 implementation of the classic game Snake.
- Host: GitHub
- URL: https://github.com/joellefkowitz/snake
- Owner: JoelLefkowitz
- License: mit
- Created: 2021-01-15T00:00:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T18:01:13.000Z (12 months ago)
- Last Synced: 2024-10-04T21:41:18.449Z (7 months ago)
- Topics: arcade, game
- Language: C++
- Homepage:
- Size: 1.07 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Snake
An SDL2 implementation of the classic game Snake.
## Example
## Documentation
Documentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/snake).
## Tooling
### Dependencies
To install dependencies:
```bash
yarn install
pip install .[all]
conan install .
```
### Tests
To run tests:
```bash
scons test
```
### Documentation
To generate the documentation locally:
```bash
scons docs
```
### Linters
To run linters:
```bash
scons lint
```
### Formatters
To run formatters:
```bash
scons format
```
### Toolchains
Scripts are defined in the `scripts` folder and can be invoked with `toolchains`:
To generate header guards:
```bash
npx toolchains guards
```
## Contributing
Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.
This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).
Bump2version is used to version and tag changes. For example:
```bash
bump2version patch
```
### Contributors
- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work
## Remarks
Lots of love to the open source community!
