forked from getodk/collect
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Describe ODK Collect project and provide informational links.
- Loading branch information
1 parent
103d332
commit bea7b16
Showing
1 changed file
with
21 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,34 @@ | ||
# collect | ||
# ODK Collect 1.0 | ||
![Platform](https://img.shields.io/badge/platform-Android-blue.svg) | ||
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | ||
[![Test coverage](https://img.shields.io/codeclimate/coverage/github/opendatakit/collect.svg)](https://codeclimate.com/github/opendatakit/collect/issues) | ||
[![Build status](https://circleci.com/gh/opendatakit/collect.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/opendatakit/collect) | ||
|
||
This project is __*actively maintained*__ | ||
ODK Collect 1.0 is an Android app for filling out forms. It is designed to be used in resource-constrained environments with challenges such as unreliable connectivity or power infrastructure. ODK Collect is part of Open Data Kit (ODK), a free and open-source set of tools which help organizations author, field, and manage mobile data collection solutions. Learn more about the Open Data Kit project and its history [here](https://opendatakit.org/about/) and read about example ODK deployments [here](https://opendatakit.org/about/deployments/). | ||
|
||
It is the ODK 1.0 Android application. | ||
|
||
The developer [wiki](https://github.com/opendatakit/opendatakit/wiki) (including release notes) and | ||
[issues tracker](https://github.com/opendatakit/opendatakit/issues) are located under | ||
the [**opendatakit**](https://github.com/opendatakit/opendatakit) project. | ||
|
||
The Google group for software engineering questions is: [opendatakit-developers@](https://groups.google.com/forum/#!forum/opendatakit-developers) | ||
* ODK website: [https://opendatakit.org](https://opendatakit.org) | ||
* ODK Collect usage instructions: [https://opendatakit.org/use/collect/](https://opendatakit.org/use/collect/) | ||
* ODK community mailing list: [http://groups.google.com/group/opendatakit](http://groups.google.com/group/opendatakit) (for discussing or getting help on using ODK tools) | ||
* ODK developer mailing list: [http://groups.google.com/group/opendatakit-developers](http://groups.google.com/group/opendatakit-developers) (for discussing the code behind ODK tools) | ||
* ODK developer wiki: [https://github.com/opendatakit/opendatakit/wiki](https://github.com/opendatakit/opendatakit/wiki) | ||
|
||
## Setting up your environment | ||
|
||
1. Fork the collect project ([why and how to fork](https://help.github.com/articles/fork-a-repo/)) | ||
1. Download and install [Android Studio](https://developer.android.com/studio/index.html) | ||
|
||
2. Fork the collect project ([why and how to fork](https://help.github.com/articles/fork-a-repo/)) | ||
|
||
2. Clone your fork of the project locally. At the command line: | ||
3. Clone your fork of the project locally. At the command line: | ||
|
||
git clone https://github.com/YOUR-GITHUB-USERNAME/collect | ||
|
||
Alternately, you can use Android Studio to create a new project from version control. | ||
If you prefer not to use the command line, you can use Android Studio to create a new project from version control. | ||
|
||
## Contributing | ||
Any and all contributions to the project are welcome. ODK Collect is used across the world primarily by organizations with a social purpose so this is a place where your code can have real impact! | ||
|
||
Issues tagged as [easy](https://github.com/opendatakit/collect/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy) should be a good place to start. There are also currently many issues tagged as [needs reproduction](https://github.com/opendatakit/collect/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+reproduction%22) which need someone to try to reproduce them with the current version of ODK Collect and comment on the issue with their findings. | ||
|
||
## Troubleshooting | ||
#### Android Studio Error: `SDK location not found. Define location with sdk.dir in the local.properties file or with an ANDROID_HOME environment variable.` | ||
When cloning the project from Android Studio, click "No" when prompted to open the `build.gradle` file and then open project. |