Improved Readme #794
There are no files selected for viewing
This file contains hidden or 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,40 +1,53 @@ | ||
| [](https://transportr.app) | ||
|
|
||
| ## Transportr | ||
|
|
||
| The public transport companion that respects your privacy and your freedom. | ||
| Transportr is a non-profit app developed by people around the world to make using public transport as easy as possible wherever you are. | ||
|
|
||
| [](https://travis-ci.org/grote/Transportr) | ||
| [](https://github.com/grote/Transportr/releases/tag/latest) | ||
| [](https://twitter.com/intent/follow?screen_name=TransportrApp) | ||
|
|
||
| ## Install | ||
|
|
||
| [](https://github.com/grote/Transportr/releases) | ||
| [](https://f-droid.org/packages/de.grobox.liberario/) | ||
|
|
||
| [<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/packages/de.grobox.liberario/) | ||
| [<img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" alt="Google Play Download" height="80">](https://play.google.com/store/apps/details?id=de.grobox.liberario) | ||
|
|
||
| * Pre-releases and beta versions for advanced users are available via [a special F-Droid repository](http://grobox.de/fdroid/). | ||
|
There was a problem hiding this comment. I wouldn't add a bullet point here. |
||
|
|
||
| ## Screenshots | ||
|
|
||
| [<img src="https://user-images.githubusercontent.com/50620416/140822064-86778b46-f701-40b0-a9bd-fc10d1397f0f.gif" height="444">](https://transportr.app/img/transportr.webm) | ||
|
There was a problem hiding this comment. Where does this come from? Is it a gif or a webm video? In either case, it should be added to the repo if we want to show it in the README. |
||
| [<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1_FirstStart.png" width="250">](fastlane/metadata/android/en-US/images/phoneScreenshots/1_FirstStart.png) | ||
| [<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2_SavedSearches.png" width="250">](fastlane/metadata/android/en-US/images/phoneScreenshots/2_SavedSearches.png) | ||
|
|
||
| <details> | ||
| <summary>More screenshots</summary> | ||
|
|
||
| [<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3_Trips.png" width="250">](fastlane/metadata/android/en-US/images/phoneScreenshots/3_Trips.png) | ||
| [<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4_TripDetails.png" width="250">](fastlane/metadata/android/en-US/images/phoneScreenshots/4_TripDetails.png) | ||
| [<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5_Station.png" width="250">](fastlane/metadata/android/en-US/images/phoneScreenshots/5_Station.png) | ||
| [<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/6_Departures.png" width="250">](fastlane/metadata/android/en-US/images/phoneScreenshots/6_Departures.png) | ||
|
|
||
| </details> | ||
|
|
||
| ## Contribute | ||
|
|
||
| All contributing guides are written in great detail on [our website](https://transportr.app/contribute/), but some are noted below: | ||
|
|
||
| * Share Transportr on social media or show your friends and family that it exists and how to use it. | ||
| * If you find any issues with this app, please report them at [the issue tracker](https://github.com/grote/Transportr/issues). | ||
| * Rate it in [Google Play](https://play.google.com/store/apps/details?id=de.grobox.liberario) and if you have a little more time also write a short review about it. | ||
| * Add more supported regions by contributing to the [Transport-Enabler](https://github.com/schildbach/public-transport-enabler/) project, which is used by Transportr. More methods are explained on the website. | ||
|
There was a problem hiding this comment. The library is called Public Transport Enabler (PTE) |
||
| * Test new Pre-releases and beta versions of Transportr before they are released to the general public (instructions above). | ||
| * People with design skills are encouraged to contribute and help making Transportr look even better. | ||
| * Translate Transportr into your native language on [Transifex](https://www.transifex.com/projects/p/transportr/). | ||
|
|
||
| ## Build from source code | ||
|
|
||
| If you want to start working on Transportr and if you haven't done already, you should [familiarize yourself with Android development](https://developer.android.com/training/basics/firstapp/index.html) and [set up a development environment](https://developer.android.com/sdk/index.html). | ||
|
|
||
|
|
@@ -47,8 +60,29 @@ If you don't want to use an IDE like Android Studio, you can build Transportr on | |
| $ cd Transportr | ||
| $ ./gradlew assembleRelease | ||
|
|
||
| ## Donations | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th colspan="3">Thank you for donating</th> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://liberapay.com/Transportr/donate/"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a> | ||
| </td> | ||
| <td align="center">Liberapay</td> | ||
| <td> | ||
| <a href="https://liberapay.com/Transportr/donate">https://liberapay.com/Transportr/donate</a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="bitcoin:12JaQp8zfqRb83JfSwVjH4rZWsZnWRPoyG"><img src="https://transportr.app/img/bitcoin-qr.png" alt="bitcoin:12JaQp8zfqRb83JfSwVjH4rZWsZnWRPoyG" width="128px" height="128px"></a></td> | ||
| <td align="center">Bitcoin</a></td> | ||
|
There was a problem hiding this comment. @grote Do you still want to accept donations via Bitcoin? There was a problem hiding this comment. I don't care either way. The original address should still work and I have still the key, but distributing it to other people is more difficult, so LiberaPay is probably better. |
||
| <td><a href="bitcoin:12JaQp8zfqRb83JfSwVjH4rZWsZnWRPoyG">12JaQp8zfqRb83JfSwVjH4rZWsZnWRPoyG</a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## License | ||
|
|
||
|  | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one doesn't work anymore. Anyone knows how to get the build status from the Github CI instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't the current one used in the README.md (
)
[](https://github.com/grote/Transportr/actions/workflows/build.yml)work just fine?