Home Explore Help
Register Sign In
apiote
/
Bimba
Watch 1
Star 0
Fork 1
Files
Tree: 0d1ee45af4
Branches Tags
Bimba
/
README.adoc

README.adoc 2.3 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 
  1. = Bimba
    2. 

  2. Adam Evyčędo <me@apiote.xyz>
    3. 

  3. v3.1 2023-06-27
    4. 

  4. :toc:
    5. 

  5. 

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

  7. 

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

  9. 

  10. == Name
    11. 

  11. 

  12. Bimba is pronounced BEEM-bah [ˈbimba].
    13. 

  13. The name is Poznań subdialect for ‘tram’.
    14. 

  14. 

  15. == Installing
    16. 

  16. 

  17. Preffered method is to download Bimba from F-Droid:
    18. 

  18. 

  19. [link=https://f-droid.org/packages/xyz.apiote.bimba.czwek]
    20. 

  20. image::https://f-droid.org/badge/get-it-on.png[Get it on F-Droid,207,80]
    21. 

  21. 

  22. == Contribute
    23. 

  23. 

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

  25. 

  26. 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].
    27. 

  27. 

  28. 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/.
    29. 

  29. 

  30. == Mirrors
    31. 

  31. 

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

  33. 

  34. 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.
    35. 

  35. 

  36. == License
    37. 

  37. 

  38. ----
    39. 

  39. Bimba Copyright (c) Adam Evyčędo
    40. 

  40. 

  41. This program is free software: you can redistribute it and/or modify
    42. 

  42. it under the terms of the GNU General Public License as published by
    43. 

  43. the Free Software Foundation, either version 3 of the License, or
    44. 

  44. (at your option) any later version.
    45. 

  45. 

  46. This program is distributed in the hope that it will be useful,
    47. 

  47. but WITHOUT ANY WARRANTY; without even the implied warranty of
    48. 

  48. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    49. 

  49. GNU General Public License for more details.
    50. 

  50. 

  51. You should have received a copy of the GNU General Public License
    52. 

  52. along with this program.  If not, see <https://www.gnu.org/licenses/>.
    53. 

  53. ----
    54. 

  54. 

  55. === Thanks to…
    56. 

  56. 

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

  58. 

  59. * https://fonts.google.com/icons[Material Icons], © Google Apache 2.0
    60. 

  60. * https://github.com/mancj/MaterialSearchBar[Search bar], © mancj MIT
    61. 

  61.