diff --git a/README.md b/README.md new file mode 100644 index 0000000..7bbc44f --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# LifeLogger + +## Outline +LifeLogger helps you log your life. + +- Decide what you want to track +- Conveniently add data points +- See graphs of your life! + +## Terminology + +- A **Log** is a thing you want to track: climbing stairs, seeing friends, ... + +- A **DataPoint** is an event pertaining to one of your Logs. + - Example: you climbed stairs to the 5th floor. + - Example: you saw a friend (Julien) today. + +## Contributing + +LifeLogger follows a few design guidelines: + +- Follow Material Design +- Leverage Jetpack whenever possible + +### Libraries + +- Use Android KTX +- Use Anko whenever it brings improvements + + + diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..c8cd490 --- /dev/null +++ b/TODO.md @@ -0,0 +1,12 @@ +# Roadmap +# V0.1 +- Validate MVP model +- MVP display +- MVP storage +- MVP Distribution + +# V0.5 +- More generic model +- Better display +- Online storage +- Material design