Skip to content

Commit aeda3bf

Browse files
authored
chore: revise README for clarity and corrections (#420)
1 parent 0fc3942 commit aeda3bf

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
CHT Android App
2-
===============
1+
# CHT Android
32

4-
The cht-android application is a thin Android wrapper to load the [CHT Core Framework](https://github.com/medic/cht-core/) web application in a Webview native container.
3+
![GitHub license](https://img.shields.io/github/license/medic/cht-android)
4+
![GitHub release](https://img.shields.io/github/v/release/medic/cht-android)
5+
[![Discourse](https://img.shields.io/badge/discourse-join-blue)](https://forum.communityhealthtoolkit.org/)
56

6-
The repository contains “flavored” configurations, where each “flavor” or “brand” is an app. This allows the application to be hardcoded to a specific CHT deployment and have a partner specific logo and display name. The app also provides some deeper integration with other android apps and native phone functions that are otherwise unavailable to webapps.
7+
CHT Android application is a thin Android wrapper to load the [CHT Core Framework](https://github.com/medic/cht-core/) web application in a Webview native container.
78

9+
The repository contains “flavored” configurations, where each “flavor” or “brand” is an app. This allows the application to be hardcoded to a specific CHT deployment and have a partner specific logo and display name. The app also provides some deeper integration with other android apps and native phone functions that are otherwise unavailable to webapps.
810

9-
## Release notes
11+
## Release Notes
1012

1113
Checkout the release notes in the [Changelog](CHANGELOG.md) page, our you can see the full release history with the installable files for sideloading [here](https://github.com/medic/cht-android/releases).
1214

13-
1415
## Development
1516

16-
Development guides are available in the "Android" section of the [Community Health Toolkit Docs Site](https://docs.communityhealthtoolkit.org/core/guides/android/). You will find instructions of how to setup your development environment, build and test new features, creates new branded apps, release, publish... and so on.
17+
Development guides are available in the "Android" section of the [Community Health Toolkit Docs Site](https://docs.communityhealthtoolkit.org/building/branding/publishing/). You will find instructions of how to setup your development environment, build and test new features, creates new branded apps, release, and publish.
1718

18-
## Settings page
19+
## Settings Page
1920
To open the app's Settings page, tap 5 times with one finger on the screen and then swipe right with two fingers, make sure to do this sequence fast. Once opened, you can change the URL of the CHT server and click "Save" to save the changes and close the Settings page.
2021

2122
## Copyright
2223

2324
Copyright 2013-2025 Medic Mobile, Inc. <[email protected]>.
2425

25-
2626
## License
2727

2828
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

0 commit comments

Comments
 (0)