Skip to content

Commit

Permalink
Updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Alastair Hughes committed Feb 16, 2016
1 parent 30b89d6 commit 6791ac4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Aspire Lite
# Aspire Asparagus Lite

TODO: Fill in this README...
This android app is designed to help asparagus farmers make crop management
decisions, for instance when to stop harvesting.
It uses Brix readings gathered from the roots of the asparagus plants to
determine an estimated CHO level, and from that can give a recommendation on
the plant state.

See the help menu in the app for details.

## Contributing

Expand Down
8 changes: 4 additions & 4 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Releasing

TODO: Write this...

Steps to put out a new release:

- Commit any changes
- Update any copyright notices
- Adjust the versionName to the current date (YYYY-MM-DD), and increment the
versionCode (both are defined in build.gradle)
- If using Android Studio, run "Sync project with gradle files"
- Build and run any tests (TODO: Flesh out)
- Build and test
- Commit any remaining changes
- Tag the commit to be released off (VCS->Git->Tag in Android studio, the tag
name should be the same as the versionName)
- Sign with the appropriate key and release (TODO: Flesh out)
- Sign with the appropriate key and release
- In Android Studio, Build->Generate Signed APK...
- Use the correct keystore, with the AspireLiteKey

Release locations:

Expand Down
6 changes: 2 additions & 4 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ Remaining TODO items for this Android app.

## Pre release

- Get the help reviewed
- Finish README.md
- Finish README.md (link to app store)
- Ensure that the remaining documentation is online (and email to Warrick)
- Finish RELEASING.md
- Double check the restricted range with Sarah
- Sanity check


## UI
Expand Down

0 comments on commit 6791ac4

Please sign in to comment.