Skip to content

Commit

Permalink
Improve readme (#21)
Browse files Browse the repository at this point in the history
Should close #13;

Set CMake requirement to the one already in the main `CMakeLists.txt`;
`sfml` to the current (latest) version; and `cpp` to the not-quite
latest (ie C++17) standard.
Shouldn't have issue by setting sfml to the latest version, but we
should probably enforce `C++17` and CMake requirements in our test suite
and stuff, but that can be addressed by other PR and issues.
  • Loading branch information
gbrivady authored Feb 23, 2023
1 parent 5c4b9ff commit 12d57e3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 12 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Soon
42 changes: 30 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
# Wiresmash
# Wiresmash <!-- omit in toc -->

Wiresmash is a Smash-like game currently under development by the iScsc dev team.

## Currently
## Table of content <!-- omit in toc -->

- [Useful links](#useful-links)
- [Current Features](#current-features)
- [Launching](#launching)
- [Building from source](#building-from-source)
- [Requirements](#requirements)
- [Building with CMake](#building-with-cmake)
- [Future Plans](#future-plans)

## Useful links

- [The iscsc website](https://iscsc.fr/)
- [How to contribute](CONTRIBUTING.md)
- [Wiresmash wiki](https://github.com/iScsc/wiresmash/wiki)

## Current Features

The game is currently a very simple demo containing:

Expand All @@ -13,23 +29,17 @@ The game is currently a very simple demo containing:

It consists of two red squares and a blue platform. The squares are controllable using (by default) the keys WASD/IJKL for up/left/down/right and Space/M for "jump".

## Next Step

- A simple combat prototype
- Better jump system
- Real kinematics system with management of velocity, more forces, ...

## Launching

Make sure to launch the executable from the `./bin` folder, or it will not find the keybinds and scream an error.

## Build
## Building from source

### Requirements

- a `C++` compiler of your choice
- `CMake`
- `SFML`
- `C++` compiler supporting `C++17` or newer, may work with an earlier standard
- `CMake 3.16+`
- `SFML 2.5.1+`

### Building with CMake

Expand All @@ -46,3 +56,11 @@ cmake --build ./build/
```

to build the executable. You will find the build executable in the `./bin` folder.

## Future Plans

- A simple combat prototype with attacks and HP bars
- Better jump system
- Real kinematics system with management of velocity, more forces, ...
- Actual graphics subsystem
- Proper input configuration

0 comments on commit 12d57e3

Please sign in to comment.