This repository has been archived by the owner on Apr 16, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 153
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
68170b4
commit 5a1648d
Showing
1 changed file
with
26 additions
and
8 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,13 +1,31 @@ | ||
# briefcase | ||
# ODK Briefcase | ||
 | ||
[](https://opensource.org/licenses/Apache-2.0) | ||
|
||
This project is __*actively maintained*__ | ||
ODK Briefcase is a desktop application that can locally store survey results gathered with [ODK Collect](https://opendatakit.org/use/collect). It can also be used to make local copies and CSV exports of data from [ODK Aggregate](https://opendatakit.org/use/aggregate/) (or compatible servers) and push data to those servers. | ||
|
||
User documentation is [here](https://opendatakit.org/use/briefcase/) | ||
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/). | ||
|
||
The Google group for user questions is: [opendatakit@](https://groups.google.com/forum/#!forum/opendatakit) | ||
* ODK website: [https://opendatakit.org](https://opendatakit.org) | ||
* ODK Briefcase usage instructions: [https://opendatakit.org/use/briefcase](https://opendatakit.org/use/briefcase) | ||
* ODK community mailing list: [http://groups.google.com/group/opendatakit](http://groups.google.com/group/opendatakit) | ||
* ODK developer mailing list: [http://groups.google.com/group/opendatakit-developers](http://groups.google.com/group/opendatakit-developers) | ||
* ODK developer Slack chat: [http://slack.opendatakit.org](http://slack.opendatakit.org) | ||
* ODK developer Slack archive: [http://opendatakit.slackarchive.io](http://opendatakit.slackarchive.io) | ||
* ODK developer wiki: [https://github.com/opendatakit/opendatakit/wiki](https://github.com/opendatakit/opendatakit/wiki) | ||
|
||
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. | ||
## Setting up your development environment | ||
|
||
The Google group for software engineering questions is: [opendatakit-developers@](https://groups.google.com/forum/#!forum/opendatakit-developers) | ||
1. Fork the briefcase project ([why and how to fork](https://help.github.com/articles/fork-a-repo/)) | ||
|
||
1. Clone your fork of the project locally. At the command line: | ||
|
||
git clone https://github.com/YOUR-GITHUB-USERNAME/briefcase | ||
|
||
We recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/). | ||
|
||
## Contributing code | ||
Any and all contributions to the project are welcome. ODK Briefcase is used across the world primarily by organizations with a social purpose so you can have real impact! | ||
|
||
## Downloading builds | ||
Released production builds can be found on the [ODK website](https://opendatakit.org/downloads/download-info/odk-briefcase/) has the current production build. |