Skip to content

Commit f890cf3

Browse files
committed
updated README.md, clean tag
1 parent 017d5a7 commit f890cf3

File tree

3 files changed

+30
-10
lines changed

3 files changed

+30
-10
lines changed

Cargo.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "lifecycler"
33
description = "Bevy Game Jam #5 submission. Terminal aquarium."
4-
version = "0.2.2"
4+
version = "0.2.3"
55
edition = "2021"
66
license = "MIT OR Apache-2.0 OR CC0-1.0"
77
authors = ["cxreiff <[email protected]>"]

README.md

+28-8
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,42 @@
22

33
[_bevy game jam #5 submission_](https://itch.io/jam/bevy-jam-5)
44

5-
## installation
5+
![logo](https://assets.cxreiff.com/github/lifecycler.png)
6+
7+
An aquarium that runs in your terminal!
8+
9+
A decoration/fidget-toy that lets you watch your fishes' lifecycle while you code. Test drive of my plugin [bevy_ratatui_render](https://github.com/cxreiff/bevy_ratatui_render).
10+
11+
## play with cargo
612

713
If you have [cargo](https://github.com/rust-lang/cargo) installed, you can simply run the following:
814

915
```sh
10-
cargo install lifecycler
16+
cargo install lifecycler --locked
1117
```
1218

13-
Alternatively you can manually download an executable from the itch.io page.
14-
15-
## play
16-
17-
To launch the game:
19+
...and then to launch the game:
1820

1921
```sh
2022
lifecycler
2123
```
2224

23-
If you manually installed the executable, you will have to include the path (e.g. `./lifecycler` if in the same directory).
25+
## controls
26+
27+
| | |
28+
|--------------------|----------------------------|
29+
| Left Click or Drag | Dispense a food pellet. |
30+
| Right click | $80 |
31+
| M | Mute/unmute sound effects. |
32+
| Q | Quit the game. |
33+
34+
## manual installation
35+
36+
Alternatively you can manually download an executable from the [itch.io page](https://cxreiff.itch.io/lifecycler) or [github releases](https://github.com/cxreiff/lifecycler/releases).
37+
38+
If you manually installed the executable, you will have to include the path to launch it (e.g. `./lifecycler` if in the same directory).
39+
40+
On macOS you may need to Right-Click > Open With, selecting a supported terminal, and then selecting Open in order to bypass code signing (I haven't figured out code signing yet).
2441

2542
## compatibility
2643

@@ -36,3 +53,6 @@ This includes a decent variety of terminals, but I have personally confirmed goo
3653
- WezTerm
3754
- iTerm2
3855

56+
## gifs
57+
58+
![day mode](https://assets.cxreiff.com/github/lifecycler_day.gif)![night mode](https://assets.cxreiff.com/github/lifecycler_night.gif)

0 commit comments

Comments
 (0)