Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joellefkowitz/snake

An SDL2 implementation of the classic game Snake.
https://github.com/joellefkowitz/snake

arcade game

Last synced: about 1 month ago
JSON representation

An SDL2 implementation of the classic game Snake.

Awesome Lists containing this project

README

        

# Snake

An SDL2 implementation of the classic game Snake.

![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/snake/review.yml)
![Quality](https://img.shields.io/codacy/grade/268409dd0e01433cb5e268b4477517a6)

## Example

![example](docs/example.gif)

## 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
```

## 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!


Be kind to your mind
Love each other
It's ok to have a bad day