Skip to content

Commit

Permalink
Improve README & add a CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
dsferruzza authored and Keruspe committed May 2, 2020
1 parent 4ce7e9b commit 582309a
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Changelog

## v1.3.0

- add a program to test integration
- support electronic hardware v1 **and** v2
(_v1 by default, v2 through a config flag_)
- implement start/stop
(_from now on, machine will begin stopped!_)
- handle Emerson valves
(_through a config flag_)
- improve the way buzzer is controlled

## v1.2.3

- fix an issue with buzzer (sometimes it was stuck buzzing whereas no alarm were triggered)
- add battery-related alarms

## v1.2.2

- handle several pneumatic systems
_(for the first 2 working typologies of prototype)_

## v1.2.1

_Unreleased_

## v1.2.0

First release version
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Versions

| Version | Last Changelog | Ready? |
| ------- | -------------- | ------ |
| V1.1.x | Initial test working | ✅
See [CHANGELOG.md](CHANGELOG.md).

Pre-compiled binaries are available in the [Releases](https://github.com/covid-response-projects/covid-respirator/releases) section.

## Documentation

Expand All @@ -13,3 +13,9 @@ Code documentation can be [found there](https://covid-response-projects.github.i
## How To Build?

In order to setup your environment and build the code, please follow the commands contained in the "[software-release](/.github/workflows/software-release.yml)" GitHub Actions file.

### Configuration

High level configuration options are available and documented in [includes/config.h](includes/config.h).

Low level configuration options can be found in [includes/parameters.h](includes/parameters.h).

0 comments on commit 582309a

Please sign in to comment.