Bimba/README.adoc

// SPDX-FileCopyrightText: Adam Evyčędo
//
// SPDX-License-Identifier: GPL-3.0-or-later

= Bimba
Adam Evyčędo <me@apiote.xyz>
v3.1 2023-06-27
:toc:

Bimba is a FLOSS public transport passenger companion; a timetable in your pocket.

Bimba can be found on https://floss.social/@bimba[Mastodon]

== Name

Bimba is pronounced BEEM-bah [ˈbimba].
The name is Poznań subdialect for ‘tram’.

== Installing

Preffered method is to download Bimba from F-Droid:

[link=https://f-droid.org/packages/xyz.apiote.bimba.czwek]
image::https://f-droid.org/badge/get-it-on.png[Get it on F-Droid,207,80]

== Contribute

This project uses The Code of Merit, which is available as CODE_OF_CONDUCT file.

Bimba is translated using https://hosted.weblate.org/projects/bimba/[Weblate]

The roadmap is available in `CHANGELOG.adoc` file and—although it’s not set in stone—feature requests are highly discouraged. Contributions, however, are welcome as patches; please send them to `bimba@git.apiote.xyz` using `git send-email`. Patches must include a sign-off to certify agreement to https://developercertificate.org/[Developer Certificate of Origin].

All communication—questions, bugs, etc.—should go through the mailing list available at `bimba@git.apiote.xyz`. Note that all communication will be made public at https://asgard.apiote.xyz/.

This project can be translated using Weblate at https://hosted.weblate.org/projects/bimba/

== Mirrors

The canonical repository for this project is https://git.apiote.xyz/Bimba.git it’s mirrored at https://notabug.org/apiote/Bimba

Mirrors exist solely for the sake of the code and any additional functions provided by third-party services (including but not limited to issues and pull requests) will not be used and will be ignored.

== License

----
Bimba Copyright (c) Adam Evyčędo

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
----

=== Thanks to…

* https://github.com/tebriz159 for new logo

* https://fonts.google.com/icons[Material Icons], © Google Apache 2.0
* https://github.com/mancj/MaterialSearchBar[Search bar], © mancj MIT