Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiasbu committed Aug 14, 2021
1 parent d033614 commit 5df0958
Showing 1 changed file with 42 additions and 12 deletions.
54 changes: 42 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,59 @@
# rhythmos-engine

_A simple rhythm tool for Unity_

![RhythmosEngine v1.3](Docs/images/rhythmos.png)

## Table of contents

_A simple rhythm tool for Unity_
- [Quick start](#quick-start)
- [Development](#development)
- [About](#about)
- [License](#license)


| :musical_note: Releases |
| ----------------------- |
| **[Get in AssetStore for free (v1.1)](https://assetstore.unity.com/packages/tools/audio/rhythmos-engine-39835)** |
## Quick start

See our [projects page](https://github.com/tobiasbu/rhythmos-engine/projects) for more information about next features.
To start using Rhythmos Engine download the last builds below.

## Table of contents
To access documentation [ click here](https://tobiasbu.github.io/rhythmos/index.html).

- [Notes](#notes)
- [License](#license)
### Last releases

## Notes

This project was created for "Games Project: Games Engines" class in 2015 at [Unisinos](http://www.unisinos.br/global/en/). It was especially made for my game Koko-Kuba. Since the asset is totally free I decided to make the code open-source.
| Version | Supported Unity version |
| ------- | ----------------------- |
| [v1.3](https://github.com/tobiasbu/rhythmos-engine/releases/tag/v1.3) | >= 2020.3.13f1 |
| [v1.1](https://assetstore.unity.com/packages/tools/audio/rhythmos-engine-39835) | 3.6, 4.6.0f, 5 and 2017 |

For installation instructions access the [Installation Guide here](https://tobiasbu.github.io/rhythmos/articles/downloads-installation-guide.html).


> _Beware!_ The code of this project was written in less than a week and is totally a mess.
## Development

### Linux - Documentation

1. Install [Mono](https://www.mono-project.com/download/stable/) and [Nuget.exe](https://www.nuget.org/downloads).

2. Install DocFX:

```bash
mono nuget.exe install docfx.console
```

3. Build documentation

```bash
mono PATH/TO/docfx.console/tools/docfx.exe Docs/docfx.json
# serve
mono PATH/TO/docfx.console/tools/docfx.exe Docs/docfx.json --serve
```

## About

This project was created for "Games Project: Games Engines" class in 2015 at [Unisinos](http://www.unisinos.br/global/en/). It was especially made for my game Koko-Kuba. Since the asset is totally free I decided to make the code open-source.

:star: I intend to bring more one update to support Unity 2020 versions and some new features See the [roadmap](https://github.com/tobiasbu/rhythmos-engine/projects) for more information.
I recently refactored all the code of this plugin and if you need a fix, update, feature, feel free to contribute to this repo. See the [roadmap](https://github.com/tobiasbu/rhythmos-engine/projects) for more information.

## License

Expand Down

0 comments on commit 5df0958

Please sign in to comment.