Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stubbed out readmes. #11

Merged
merged 1 commit into from Oct 20, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Expand Up @@ -10,11 +10,17 @@ The easiest way to demonstrate a specific architecture/library, is to isolate it

Each module will be tested as much as it can be. This may include a mix of unit tests and UI tests.

You can find modules that explain:

* [MVP](/todo-mvp)
* [MVVM](/todo-mvvm)
* [CORE](/core) which contains shared code.

## Sample

While the title of this gif says 'MVP', this is what you can expect the todo list app in each module to look like. A landing page with a list of sample items, a floating action button that leads to an add task screen, where you can enter the task and be sent back to the main screen.

<img src="/images/sample.gif" style="height: 640px; width: 400px;">
You can view the sample [here](/images/sample.gif).

## Contributions / Requests

Expand Down
5 changes: 5 additions & 0 deletions core/README.md
@@ -0,0 +1,5 @@
# CORE

This module contains any core code that affects more than one of the individual models. That includes mostly the activity layouts that are the same in each module.

We want to emphasize the different architecture patterns, and not clutter each module with repeated XML files, or model classes, that appear in each one.
5 changes: 5 additions & 0 deletions todo-mvp/README.md
@@ -0,0 +1,5 @@
# MVP

This module is to demonstrate to Model-View-Presenter pattern.

Blog post to be written.
5 changes: 5 additions & 0 deletions todo-mvvm/README.md
@@ -0,0 +1,5 @@
# MVVM

This module demonstrates the Model-View-ViewModel architecture pattern.

Blog post to be written.