Skip to content

Commit

Permalink
Add 1.0.0 release notes (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
Antolius authored Jul 24, 2022
1 parent e8825a2 commit bff09ff
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 12 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@

[Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) made for [elementary OS](https://elementary.io/).

[![Get it on AppCenter](https://appcenter.elementary.io/badge.svg)](https://appcenter.elementary.io/hr.from.josipantolis.life)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](COPYING)
[![Build](https://github.com/Antolius/Life/actions/workflows/ci.yml/badge.svg)](https://github.com/Antolius/Life/actions)
[![GitHub release](https://img.shields.io/github/v/release/Antolius/Life)](https://github.com/Antolius/Life/releases)

|![Default style screenshot](data/screenshots/default.png)|![Dark style screenshot](data/screenshots/dark.png) |
|---------------------------------------------------------|-----------------------------------------------------------------|
Expand All @@ -27,7 +29,7 @@ For more screenshots check out the [screenshots directory](data/screenshots).

## Status

Life is currently in pre-release stage of development. This means that while things are shaping up there are still bugs, app crashes, and missing features. Here's a rough list of features which work already and those that I'd like to add / polish before the initial release:
Life is in active development. It currently supports following set of features:

- [x] App can run a Game of Life simulation at various speeds with automatically expanding simulation boundaries.
- [x] User can draw and erase live cells to create patterns in the simulation.
Expand All @@ -36,7 +38,7 @@ Life is currently in pre-release stage of development. This means that while thi
- [x] User can save / open cell patterns into / from files.
- [x] App remembers and restores current pattern of cells between restarts.
- [x] Operations of running the simulation, writing to files and interacting with the UI don't block each other.
- [x] User without previous knowledge of Game of Life can learn basics from a built-in tutorial.
- [x] User without previous knowledge of Game of Life can learn basics from a built-in primer.

I'm also considering adding some features after the initial release:

Expand All @@ -46,7 +48,7 @@ I'm also considering adding some features after the initial release:
- [ ] More advanced filter and search over the Patterns Library.
- [ ] Adding more patterns into the Patterns Library.

The app will be released in the [elementary OS AppCenter](https://appcenter.elementary.io/) as a flatpak. However, for now the only way to install it is by building it from the source code.
Check out [GitHub issues](https://github.com/Antolius/Life/issues) for more details.

## How to build from source

Expand Down
27 changes: 21 additions & 6 deletions data/life.appdata.xml.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,28 @@
<name>Life</name>
<summary>Conway's Game of Life</summary>
<description>
<p>Explore a wonderful world of cellular automata. Craft patterns, watch them grow and evolve.</p>
<p>Life makes it easy to run Conway's Game of Life simulations. You can craft your own patterns and explore their evolution, or browse the library of common patterns included with the app. And if you are new to this hobby, there's an onboarding tutorial to help you familiarize yourself with the rules.</p>
<p>Explore a wonderful world of cellular automata. Discover patterns and watch them evolve.</p>
<p>Life makes it easy to run Conway's Game of Life simulations. You can craft your own patterns and explore their evolution, or browse the library of common patterns included within the app. If you are new to this hobby, the app includes a primer with everything you'll need to know.</p>
</description>

<metadata_license>CC-BY-4.0</metadata_license>
<project_license>GPL-3.0-or-later</project_license>

<releases>
<release version="1.0.0" date="2022-07-24">
<description>
<p>Initial release, bringing you:</p>
<ul>
<li>A (near) endless field to run your Game of Life simulations on.</li>
<li>A primer to get you familiarized with Conway's Game of Life.</li>
<li>A library of patterns to explore and experiment with.</li>
<li>Helpful editing tools to make adjusting your creations easier.</li>
<li>Support for popular Plaintext file format for Game of Life patterns.</li>
</ul>
</description>
</release>
</releases>

<custom>
<value key="x-appcenter-suggested-price">0</value>
</custom>
Expand All @@ -22,16 +37,16 @@

<screenshots>
<screenshot type="default">
<image>https://raw.githubusercontent.com/antolius/life/main/data/screenshots/default.png</image>
<image>https://raw.githubusercontent.com/antolius/life/1.0.0/data/screenshots/default.png</image>
<caption>An in-progress Game of Life simulation showcasing the default (light) style</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/antolius/life/main/data/screenshots/dark.png</image>
<image>https://raw.githubusercontent.com/antolius/life/1.0.0/data/screenshots/dark.png</image>
<caption>An in-progress Game of Life simulation showcasing the dark style</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/antolius/life/main/data/screenshots/onboarding.png</image>
<caption>A step in the tutorial teaching you the rules of the Game of Life</caption>
<image>https://raw.githubusercontent.com/antolius/life/1.0.0/data/screenshots/onboarding.png</image>
<caption>A step in the primer explaining Game of Life rules</caption>
</screenshot>
</screenshots>

Expand Down
4 changes: 2 additions & 2 deletions data/life.desktop.in
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Type=Application

Name=Life
GenericName=Conway's Game of Life
Comment=Craft patterns, watch them grow and evolve
Categories=Game;Education;Science;Math
Comment=Discover patterns, watch them grow and evolve
Categories=Education;Science;Math;GTK;
Keywords=Conway;Life;Cellular;Automaton;Automata;
Icon=hr.from.josipantolis.life
Expand Down
2 changes: 1 addition & 1 deletion meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
project (
'hr.from.josipantolis.life',
'c', 'vala',
version: '0.1.0'
version: '1.0.0'
)

# Translation module
Expand Down

0 comments on commit bff09ff

Please sign in to comment.