szczanieckiej/README.adoc

// SPDX-FileCopyrightText: Adam Evyčędo
//
// SPDX-License-Identifier: AGPL-3.0-or-later

= szczanieckiej
Adam Evyčędo <me@apiote.xyz>
v0.4 2024-05-16
: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 current version, one needs:

* 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/szczanieckiej.toml")
  command
      one of (serve|convert)
----

== Configuration

The exmaple config file, showing defaults for `feeds_path` and `listen_address`, is:
```
feeds_path = "/var/lib/szczanieckiej"
listen_address = ":51354"
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/.

This project can be translated using Weblate at https://hosted.weblate.org/projects/bimba/

To add another public transport network, follow instructions in `traffic/feed_example.go`

== 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

----
szczanieckiej Copyright (C) Adam Evyčędo

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