Skip to content

Commit

Permalink
Add basic documentation (#237)
Browse files Browse the repository at this point in the history
* Add basic documentation

* Improve project description paragraphs for added clarity and simplicity

* Add link to learn more about Digital Skills Observatory

* Simplify installation instructions

* Add link to chat.mozillafoundation.org in Contribute section

* Fix contribute section not actually linking to contributing guide

* Derp :bowtie

* Improve contribute descriptions for added clarity and simplicity

* Clean up terminology table and language

* Add logo and revise contribute layout

* Remove old documentation folder, Update image path

* Remove old dso app wireframes

* Fix logo not displaying, See isaacs/github#316

* Fix file not actually being converted to a png

* Add USB Debugging & App Setup instructions to documentation

* Minor style tweaks, clean up a bit

* Add Android Studio installation documentation

* Remove manual install guide for android sdk

* Fix broken contributing guide link in readme

* Add mofo engineering guidebook to contribute table of contents

* Add detailed install instructions to README

* Add MoFo Engineering Standards segment to contribute guide

* Add building information to contribute guide

* Some formatting changes to build type stuff

* Custom guide
  • Loading branch information
ryanwarsaw committed Jan 2, 2017
1 parent f314fb5 commit 2589025
Show file tree
Hide file tree
Showing 11 changed files with 200 additions and 253 deletions.
24 changes: 24 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Participation Guidelines

This project respects Mozilla's [community participation guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/). These guidelines cover our behaviour as participants, facilitators, space wranglers, staff, volunteers, vendors, and anyone else involved in making the MozFest possible.

## How to treat each other

* Be respectful and welcoming
* Try to understand different perspectives
* Do not threaten violence
* Empower others
* Strive for excellence
* Don’t expect to agree with every decision

## Inclusion and Diversity

The Mozilla Project welcomes and encourages participation by everyone. It doesn’t matter how you identify yourself or how others perceive you: we welcome you.

We welcome contributions from everyone as long as they interact constructively with our community, including, but not limited to people of varied age, culture, ethnicity, gender, gender-identity, language, race, sexual orientation, geographical location and religious views.

Mozilla-based activities should be inclusive and should support such diversity.

## Working in the Open

Because working open is one of our core values, MozFest program planning is done in the open on Github (check out our repo [here](https://github.com/MozillaFoundation/mozfest-program-2016)). We hope participants will benefit from this culture of transparency and collaboration during the Festival, and will continue to work with an open ethos in their projects after Mozfest. Learn more about [how we work open at Mozilla](https://wiki.mozilla.org/Working_open).
22 changes: 0 additions & 22 deletions CREDITS.md

This file was deleted.

44 changes: 27 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,37 @@
Mozilla DSO Android App
======================
# Jisort! [![Build Status](https://travis-ci.org/mozilla/Jisort.svg?branch=master)](https://travis-ci.org/mozilla/Jisort) [![Uses Mofo Standards](https://MozillaFoundation.github.io/mofo-standards/badge.svg)](https://github.com/MozillaFoundation/mofo-standards)

Description goes here..
Jisort! is an informational prototype app for the Digital Skills Observatory project. It offers fun and visually interesting ways to increase basic smart phone awareness and skills, diagnose problems, and encourage exploration.

<h2>Source</h2>
The Digital Skills Observatory project looks at the impact of digital skills on the usage of Digital Financial Services. Testing various teaching and delivery methods, the study aims to understand the skills people need to develop confidence and agency with their smart phones. [Learn more](http://mozillafoundation.github.io/digital-skills-observatory/).

The source code in this repository reflects the app's current status.
## Features

<h2>Features</h2>
- Compatible with Android 4.0 (API 14) and above
- Simple and intuitive user interface
- Suggest content to users based on system events like low battery, or wifi status
- Customizable: create your own content using HTML tags and JSON
- Offline analytics collection system

With the app, you can:
## Install

- View tutorial content.
- View suggested topics based on system events like low battery; wifi, location or bluetooth status.
- View detailed tutorial content.
- Enable/disable app FAB.
Jisort! is not available on app marketplaces such as Google Play. Follow the instructions below to manually install the app.

<h2>How to Work with the Source</h2>
1. Startup the internet browser on the Android device you'd like to install Jisort! on
2. Enter the following website address into your browser's address bar: ```https://mzl.la/jisort```
3. Look for the version with the green "latest release" tag, and download the file ending with the extension name: ```apk```
4. Navigate to your downloads folder and verify that the downloaded file looks similar to the following: ```Jisort-qualityassurance-<version>-SNAPSHOT.apk```
5. Tap on the downloaded file to begin the installation process
6. If prompted with a pop-up asking if you'd like to install the application, select the appropriate answers (yes)
7. Once the application has been successfully installed, you will be notified and can find it in your app drawer

We hope the source code for this app is useful for you as a reference or starting point for creating your own apps. Here is some additional reading to help you better understand and reuse this code.
## Contribute

* [Build instructions](doc/BUILDING.md): instructions on how to build and run the code.
* [Customization guide](doc/CUSTOM.md)
Did you know that the Digital Skills Observatory project is mostly run by community members just like you? Community contributions have played an important role in both the Digital Skills Observatory project, and the development of Jisort!

<h2>Contributors/Credits</h2>
More contributor information can be found in the [CREDITS.md](CREDITS.md) file.
If you're interested in contributing, check out the [contributing guide](docs/CONTRIBUTE.md) and come say hello in our [chat room](https://chat.mozillafoundation.org).

## License

Jisort! is licensed under [Mozilla Public License 2.0](LICENSE.md)

Have questions about Mozilla Public License 2.0? Check out the [FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/).
Binary file removed Resources/dso-app-wireframes.pdf
Binary file not shown.
72 changes: 0 additions & 72 deletions doc/BUILDING.md

This file was deleted.

43 changes: 0 additions & 43 deletions doc/CUSTOM.md

This file was deleted.

99 changes: 0 additions & 99 deletions doc/SYNC.md

This file was deleted.

76 changes: 76 additions & 0 deletions docs/CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contribute

Mozilla Foundation currently (as of 2016) uses Mattermost as our communications solution. If at any point you need help, have a question or just want to say hello; join our [chat room](https://chat.mozillafoundation.org).

* [Install Android Studio](#install-android-studio)
* The first step of getting set up for Android development is installing Android Studio.
* [USB Debugging](#usb-debugging)
* USB debugging allows you to use your phone in order to test your app changes and debug them if necessary.
* [Setup Jisort App](#setup-jisort-app)
* All the steps needed to get a local version of the Jisort! app repository running locally on your Android phone.
* [Review MoFo Engineering Standards](#review-mofo-engineering-standards)
* Mozilla Foundation's engineering standards is a guide book that details best practices when contributing.
* [Building Jisort App](#building-jisort-app)
* Information on how to build Jisort! as well as a table with all build types and descriptions.

## Install Android Studio

* Verify that you have Java 1.8 and [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) installed for your platform

* Download and install Android Studio from: https://developer.android.com/studio/index.html

* After it has installed successfully, you should see the following screen:

![android studio menu](img/android-studio-menu.png)
## USB Debugging

* In order to start testing apps on your physical Android device, we need to first activate developer mode by tapping ```Settings > About > Build Number``` seven times

* Once activated, go to ```Settings > Developer Options > USB Debugging``` and make sure USB Debugging is enabled

* Connect your phone to your computer via USB and select the green "run" button from the Android Studio tool bar or hit ```Run > Run 'app'``` from the menu bar. Your device should show up under the "Connected Devices" tab. If you've installed Android command line tools, you can also verify your phone is connected by running ```adb devices``` from the command line

* [This guide](http://www.howtogeek.com/129728/how-to-access-the-developer-options-menu-and-enable-usb-debugging-on-android-4.2/) has additional information for enabling USB Debugging

## Setup Jisort App

* Clone the Jisort code repository from [mozilla/Jisort](https://github.com/mozilla/Jisort)

* In Android Studio, choose "Open an existing Android project"

* Select the Jisort folder, and press open

* Connect your device via USB, and press the "run" button:

![run button](img/android-run-btn.png)

## Review MoFo Engineering Standards

The Mozilla Foundation engineering standards guidebook outlines the best practices used by Mozilla Foundation's engineering team. It provides helpful information to first time and veteran contributors alike.

Jisort! is a mofo-standard compliant repository, we follow these standards where ever applicable.

You can review the guidebook [here](https://github.com/MozillaFoundation/mofo-standards).

## Building Jisort App

There are currently four build types for Jisort! See the table below for a description of each one.

| Build Type | Description |
| ---------- | ----------- |
| debug | Recommended build type for testing code changes |
| latest | Strips semantic versioning information, used for build deployment |
| qualityassurance | Considered a "pre-release" build candidate for release |
| release | Approved release build, signed with non-debug Mozilla signature |


To assemble a specific build type, append it to the end of the assemble build type like this:

```./gradlew assembleDebug```

If you don't specify a build type (i.e. ```./gradle assemble```) Gradle will assemble all build types.

You can also assemble and install the APK directly on your phone if it's connected over the adb (Android Device Bridge) by using the Gradle ```install``` task and appending the build type you'd like to install to the end like this:

```./gradlew installDebug```

Loading

0 comments on commit 2589025

Please sign in to comment.