Author: Adam Pioterek <apioterek@consdata.com>
add bimba.czwek and szczanieckiej
programs/bimba.adoc | 60 +++++++++++++++++++++++++++++ programs/index.dirty | 28 +++++++++++++ programs/szczanieckiej.adoc | 79 +++++++++++++++++++++++++++++++++++++++
diff --git a/programs/bimba.adoc b/programs/bimba.adoc new file mode 100644 index 0000000000000000000000000000000000000000..afbd4fa417b2548febc28e4c00e9ba7e4970c5bb --- /dev/null +++ b/programs/bimba.adoc @@ -0,0 +1,60 @@ += Bimba +apiote <me@apiote.xyz> +v3.0 2023-04-11 +: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. + +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/. + +== 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) apiote + +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 diff --git a/programs/index.dirty b/programs/index.dirty index 13a518b319032a5516d82ecb9571c8a2d29eb959..934ca431b6860f4a7100429f6347475e31d3750d 100644 --- a/programs/index.dirty +++ b/programs/index.dirty @@ -42,6 +42,20 @@ ) ) ) ( + ('name' 'bimba') + ('tldr' 'FLOSS public transport passenger companion; a timetable in your pocket') + ('defaultVersion' '') + ('source' 'https://git.apiote.xyz/git/Bimba.git') + ('versions' + ( + ('' ( + ('description' 'bimba.adoc') + ('module' 'apiote.xyz/p/bimba') + )) + ) + ) + ) + ( ('name' 'eeze') ('tldr' 'simple secret storage/password manager') ('defaultVersion' '') @@ -111,6 +125,20 @@ ( ('' ( ('description' 'meowsum.adoc') ('module' 'apiote.xyz/p/meowsum') + )) + ) + ) + ) + ( + ('name' 'szczanieckiej') + ('tldr' 'TRAFFIC server for Bimba') + ('defaultVersion' '') + ('source' 'https://git.apiote.xyz/git/szczanieckiej.git') + ('versions' + ( + ('' ( + ('description' 'szczanieckiej.adoc') + ('module' 'apiote.xyz/p/szczanieckiej') )) ) ) diff --git a/programs/szczanieckiej.adoc b/programs/szczanieckiej.adoc new file mode 100644 index 0000000000000000000000000000000000000000..a3b8e9f438959396bb84c7e77098c0f4b1f8958b --- /dev/null +++ b/programs/szczanieckiej.adoc @@ -0,0 +1,79 @@ += a·muse +apiote <me@apiote.xyz> +v0.1 2023-04-05 +:toc: + +szczanieckiej is a https://git.apiote.xyz/traffic.git[TRAFFIC] server that is a part of bimba. + +== Name + +szczanieckiej is pronounced [ʂt͡ʂa'ɲɛt͡s.kjɛj], somwhat like shtcha-NYE-tskyey. + +It’s a name of a tram terminus in Poznań that no longer exists and which was located on Szczanieckiej street. +The terminus was opened in 1925 as part of preparations for Polish General Exhibition—the biggest expo that has existed in Poland to this day, which was organised in 1929 to commemorate 10 years of Polish independence. + +== Building + +To build version 0.1, You need: + +* TRAFFIC repo in `../traffic/` +* `awk` +* `bare-gen` from https://git.sr.ht/~sircmpwn/go-bare +* `mk` + +Then, all You have to do is run `mk` + +== Running + +---- +./szczanieckiej [-c configPath] command: + -c string + configPath (default "/etc/bimba.toml") + command + one of (serve|convert) +---- + +== Configuration + +The exmaple config file is: +``` +feeds_path = "/usr/share/szczanieckiej" +admin_contact = "mailto:admin@example.com" +rate_limited = true +private = false + +enabled_feeds = [ "poznan_ztm" ] +``` + +== Contribute + +This project uses The Code of Merit, which is available as CODE_OF_CONDUCT file. + +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 `szczanieckiej@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 `szczanieckiej@git.apiote.xyz`. Note that all communication will be made public at https://asgard.apiote.xyz/. + +== Mirrors + +The canonical repository for this project is https://git.apiote.xyz/szczanieckiej.git it’s mirrored at https://notabug.org/apiote/szczanieckiej + +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 + +---- +amuse Copyright (C) apiote + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero 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 Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see <https://www.gnu.org/licenses/>. +----