Please read this file as a raw textual file, it has comments for people who create a new repo from this template.

This repository is a template that we use at Serokell to create new repositories. See GitHub documentation for more details about this feature.

If you have just created a new repo from this template, please start from here. Here are some things to keep in mind:

We have a page in Notion describing how to create a new repository.
Make sure to read meta-comments (you won't see them in rendered markdown because they are comments, but you can see them in raw files) and remove them eventually. You can check that all meta-comments are removed using git grep '\[\/\/\]:'.
Since we have repos at GitHub and GitLab, we provide both .github/ and .gitlab/ folders, one of them should be removed.
The root LICENSE file is present because it's treated specially by GitHub and GitLab. Please put the right license there (or delete it if there is no license).
Move any applicable licenses from .reuse/LICENSES/ to LICENSES/, and delete the rest.
In general, it's highly advised that you go over all files and check whether they make sense in your new repo. The aforementioned Notion page should help you. If you make a PR that adapts this template for your new project, reviewers of your PR can help you as well.
Templates for nix infrastructure and CI are in a separate repository.
Everything above this line, except for the copyright header, is supposed to be removed.

Patak

Patak is a modern tool which is good at doing X using Y because Z.

Build Instructions ↑

Run make to build everything.

Launch patak executable and see how it does X. If you pass --impress you will be impressed. Pass --help to see all flags and options.

We use YouTrack as our issue tracker. You can login using your GitHub account to leave a comment or create a new issue.

Please see CONTRIBUTING.md for more information.

Patak is maintained and funded with ❤️ by Serokell. The names and logo for Serokell are trademark of Serokell OÜ.

We love open source software! See our other projects or hire us to design, develop and grow your idea!