README.adoc 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. // SPDX-FileCopyrightText: Adam Evyčędo
  2. //
  3. // SPDX-License-Identifier: GPL-3.0-or-later
  4. = Bimba
  5. Adam Evyčędo <me@apiote.xyz>
  6. v3.7.1 2024-11-30
  7. :toc:
  8. Bimba is a FLOSS public transport passenger companion; a timetable in your pocket.
  9. Bimba can be found on https://floss.social/@bimba[Mastodon]
  10. == Name
  11. Bimba is pronounced BEEM-bah [ˈbimba].
  12. The name is Poznań subdialect for ‘tram’.
  13. == Installing
  14. Preffered method is to download Bimba from F-Droid:
  15. [link=https://f-droid.org/packages/xyz.apiote.bimba.czwek]
  16. image::https://f-droid.org/badge/get-it-on.png[Get it on F-Droid,207,80]
  17. == Contribute
  18. This project uses The Code of Merit, which is available as CODE_OF_CONDUCT file.
  19. Bimba is translated using https://hosted.weblate.org/projects/bimba/[Weblate]
  20. 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 mailto:patches@bimba.app using `git send-email`. Patches must include a sign-off to certify agreement to https://developercertificate.org/[Developer Certificate of Origin].
  21. == Contact
  22. Communication—questions, bugs, etc.—should go through either:
  23. * the mailing list at mailto:questions@bimba.app,
  24. * the public Matrix channel https://matrix.to/#/#marblearch:apiote.xyz[#marblearch:apiote.xyz],
  25. * the Mastodon account at https://floss.social/@bimba
  26. Note that all communication may be or will be made public.
  27. == Mirrors
  28. The canonical repository for this project is https://git.apiote.xyz/Bimba.git it’s mirrored at https://notabug.org/apiote/Bimba and https://codeberg.org/apiote/Bimba
  29. 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.
  30. == License
  31. ----
  32. Bimba Copyright (c) Adam Evyčędo
  33. This program is free software: you can redistribute it and/or modify
  34. it under the terms of the GNU General Public License as published by
  35. the Free Software Foundation, either version 3 of the License, or
  36. (at your option) any later version.
  37. This program is distributed in the hope that it will be useful,
  38. but WITHOUT ANY WARRANTY; without even the implied warranty of
  39. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  40. GNU General Public License for more details.
  41. You should have received a copy of the GNU General Public License
  42. along with this program. If not, see <https://www.gnu.org/licenses/>.
  43. ----
  44. === Thanks to…
  45. * https://github.com/tebriz159 for new logo
  46. * https://material.io/icons[Material Icons], © Google Apache 2.0