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

README.adoc 2.6 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 
  1. // SPDX-FileCopyrightText: Adam Evyčędo
    2. 

  2. //
    3. 

  3. // SPDX-License-Identifier: GPL-3.0-or-later
    4. 

  4. 

  5. = Bimba
    6. 

  6. Adam Evyčędo <me@apiote.xyz>
    7. 

  7. v3.7.1 2024-11-30
    8. 

  8. :toc:
    9. 

  9. 

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

  11. 

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

  13. 

  14. == Name
    15. 

  15. 

  16. Bimba is pronounced BEEM-bah [ˈbimba].
    17. 

  17. The name is Poznań subdialect for ‘tram’.
    18. 

  18. 

  19. == Installing
    20. 

  20. 

  21. Preffered method is to download Bimba from F-Droid:
    22. 

  22. 

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

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

  25. 

  26. == Contribute
    27. 

  27. 

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

  29. 

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

  31. 

  32. 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].
    33. 

  33. 

  34. == Contact
    35. 

  35. 

  36. Communication—questions, bugs, etc.—should go through either:
    37. 

  37. 

  38. * the mailing list at mailto:questions@bimba.app,
    39. 

  39. * the public Matrix channel https://matrix.to/#/#marblearch:apiote.xyz[#marblearch:apiote.xyz],
    40. 

  40. * the Mastodon account at https://floss.social/@bimba
    41. 

  41. 

  42. Note that all communication may be or will be made public.
    43. 

  43. 

  44. == Mirrors
    45. 

  45. 

  46. 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
    47. 

  47. 

  48. 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.
    49. 

  49. 

  50. == License
    51. 

  51. 

  52. ----
    53. 

  53. Bimba Copyright (c) Adam Evyčędo
    54. 

  54. 

  55. This program is free software: you can redistribute it and/or modify
    56. 

  56. it under the terms of the GNU General Public License as published by
    57. 

  57. the Free Software Foundation, either version 3 of the License, or
    58. 

  58. (at your option) any later version.
    59. 

  59. 

  60. This program is distributed in the hope that it will be useful,
    61. 

  61. but WITHOUT ANY WARRANTY; without even the implied warranty of
    62. 

  62. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    63. 

  63. GNU General Public License for more details.
    64. 

  64. 

  65. You should have received a copy of the GNU General Public License
    66. 

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

  67. ----
    68. 

  68. 

  69. === Thanks to…
    70. 

  70. 

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

  72. * https://material.io/icons[Material Icons], © Google Apache 2.0
    73. 

  73.