README.adoc 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. = Bimba
  2. Adam Evyčędo <me@apiote.xyz>
  3. v3.1 2023-06-27
  4. :toc:
  5. Bimba is a FLOSS public transport passenger companion; a timetable in your pocket.
  6. Bimba can be found on https://floss.social/@bimba[Mastodon]
  7. == Name
  8. Bimba is pronounced BEEM-bah [ˈbimba].
  9. The name is Poznań subdialect for ‘tram’.
  10. == Installing
  11. Preffered method is to download Bimba from F-Droid:
  12. [link=https://f-droid.org/packages/xyz.apiote.bimba.czwek]
  13. image::https://f-droid.org/badge/get-it-on.png[Get it on F-Droid,207,80]
  14. == Contribute
  15. This project uses The Code of Merit, which is available as CODE_OF_CONDUCT file.
  16. 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].
  17. 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/.
  18. == Mirrors
  19. The canonical repository for this project is https://git.apiote.xyz/Bimba.git it’s mirrored at https://notabug.org/apiote/Bimba
  20. 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.
  21. == License
  22. ----
  23. Bimba Copyright (c) Adam Evyčędo
  24. This program is free software: you can redistribute it and/or modify
  25. it under the terms of the GNU General Public License as published by
  26. the Free Software Foundation, either version 3 of the License, or
  27. (at your option) any later version.
  28. This program is distributed in the hope that it will be useful,
  29. but WITHOUT ANY WARRANTY; without even the implied warranty of
  30. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  31. GNU General Public License for more details.
  32. You should have received a copy of the GNU General Public License
  33. along with this program. If not, see <https://www.gnu.org/licenses/>.
  34. ----
  35. === Thanks to…
  36. * https://github.com/tebriz159 for new logo
  37. * https://fonts.google.com/icons[Material Icons], © Google Apache 2.0
  38. * https://github.com/mancj/MaterialSearchBar[Search bar], © mancj MIT