Skip to content

Commit

Permalink
Adds contributor and simplifies AS instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseAlcerreca committed May 10, 2016
1 parent 6f9cc46 commit f7a789f
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ make testing, maintaining and extending difficult.

Android Architecture Blueprints is meant to demonstrate possible ways to help
with these common problems. In this project we offer the same application
implemented using different architectural concepts and tools.
implemented using different architectural concepts and tools.

You can use these samples as a reference or as a starting point for creating
your own apps. The focus here is on code structure, architecture, testing and
maintainability. However, bear in mind that there are many ways to build apps
with these architectures and tools, depending on your priorities, so these
shouldn't be considered canonical examples. The UI is deliberately kept simple.
shouldn't be considered canonical examples. The UI is deliberately kept simple.

### What does <em>beta</em> mean?

We're still making decisions that could affect all samples so we're keeping the
initial number of variants low before the stable release.
initial number of variants low before the stable release.

## Samples

Expand All @@ -32,7 +32,7 @@ more information.
* [todo-mvp-databinding/](https://github.com/googlesamples/android-architecture/tree/todo-databinding/) - Based on todo-mvp, uses the Data Binding Library.
* [todo-mvp-clean/](https://github.com/googlesamples/android-architecture/tree/todo-mvp-clean/) - Based on todo-mvp, uses concepts from Clean Architecture.
* [todo-mvp-dagger/](https://github.com/googlesamples/android-architecture/tree/todo-mvp-dagger/) - Based on todo-mvp, uses Dagger2 for Dependency Injection

In progress:

* [dev-todo-mvp-contentproviders/](https://github.com/googlesamples/android-architecture/tree/dev-todo-mvp-contentproviders/) - Based on todo-mvp-loaders, uses Content Providers
Expand All @@ -44,7 +44,7 @@ Also, see ["New sample" issues](https://github.com/googlesamples/android-archite

The aim of the app is to be simple enough that it's understood quickly, but
complex enough to showcase difficult design decisions and testing scenarios.
Check out the [app's specification](https://github.com/googlesamples/android-architecture/wiki/To-do-app-specification).
Check out the [app's specification](https://github.com/googlesamples/android-architecture/wiki/To-do-app-specification).

<img src="https://github.com/googlesamples/android-architecture/wiki/images/tasks2.png" alt="Screenshot" width="160" style="display: inline; float: right"/>

Expand All @@ -58,28 +58,28 @@ app, the size and experience of your team, the amount of maintenance that you
foresee, whether you need a tablet layout or support multiple platforms, how
compact you like your codebase, etc.

## Importing the project in Android Studio
## Opening a sample in Android Studio

In order to open the project in Android Studio, first checkout one of the feature branches (<code>master</code> won't compile), and then choose to import the <code>todoapp/</code> inner folder, NOT the parent <code>android-architecture/</code> folder.
First check out one of the sample branches (`master` won't compile), and then choose to open the `todoapp/` directory. Example:

* eg. <code>git clone [email protected]:googlesamples/android-architecture.git</code>
* inside the repository folder, checkout the branch of your interest, eg. 'todo-mvp' - <code>git checkout todo-mvp</code>
* <code>todoapp/</code> folder should appear, which is the project app's folder
* start Android Studio and choose 'Import project...'
* point at the <code>todoapp/</code> folder, NOT the parent <code>android-architecture/</code> folder
* `git clone [email protected]:googlesamples/android-architecture.git`
* `git checkout todo-mvp` (or replace `todo-mvp` with the project you want to check out)
* In Android Studio open the `todoapp/` directory.

## Who is behind this project?

This project is **built by the community** and curated by Google and core maintainers.

### External contributors
### External contributors

[David González](https://github.com/malmstein) - Core developer (Content Providers sample)

[Karumi](https://github.com/Karumi) - Developers (MVP Clean architecture sample)

[Erik Hellman](https://github.com/ErikHellman) - Developer (MVP RxJava sample)

[Saúl Molinero](https://github.com/saulmm) - Developer (MVP Dagger sample)

### Googlers

[Jose Alcérreca](https://github.com/JoseAlcerreca) - Lead/Core developer
Expand Down

0 comments on commit f7a789f

Please sign in to comment.