+1
.github/CODEOWNERS
+1
.github/CODEOWNERS
···
1
+
* @taciturnaxolotl
.github/images/carriage.webp
.github/images/carriage.webp
This is a binary file and will not be displayed.
+1
.github/images/line-break-thin.svg
+1
.github/images/line-break-thin.svg
···
1
+
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" id="svg" width="400" height="41.058" viewBox="0 0 400 41.058"><style>:root{--borderColor-muted:#363A4F}@media (prefers-color-scheme:light){:root{--borderColor-muted:#CCD0DA}}</style><g id="svgg"><path id="path0" fill="var(--borderColor-muted)" fill-rule="evenodd" stroke="none" d="M360.790 1.671 C 360.900 1.699,361.079 1.699,361.189 1.671 C 361.298 1.642,361.208 1.619,360.989 1.619 C 360.771 1.619,360.681 1.642,360.790 1.671 M355.242 3.554 L 354.564 4.265 355.274 3.586 C 355.665 3.213,355.985 2.893,355.985 2.875 C 355.985 2.791,355.873 2.894,355.242 3.554 M378.846 8.587 C 378.569 8.868,378.369 9.099,378.400 9.099 C 378.431 9.099,378.683 8.868,378.959 8.587 C 379.236 8.305,379.436 8.075,379.405 8.075 C 379.373 8.075,379.122 8.305,378.846 8.587 M367.183 10.719 L 366.733 11.203 367.216 10.753 C 367.666 10.335,367.752 10.236,367.666 10.236 C 367.647 10.236,367.430 10.454,367.183 10.719 M351.747 11.118 C 351.011 11.540,350.225 12.032,350.002 12.211 L 349.596 12.537 350.032 12.990 C 350.981 13.975,352.792 15.208,354.259 15.866 C 354.927 16.165,354.962 16.201,354.962 16.580 L 354.962 16.979 353.568 16.911 C 351.318 16.800,349.088 16.039,347.531 14.851 C 346.902 14.371,347.009 14.385,346.311 14.686 L 345.749 14.927 345.749 15.862 L 345.749 16.798 343.958 16.873 C 342.973 16.914,278.985 16.947,201.762 16.946 L 61.357 16.944 61.050 16.558 C 60.844 16.301,60.354 15.985,59.572 15.606 C 57.925 14.809,57.974 14.816,57.407 15.276 C 55.993 16.425,53.576 17.255,51.322 17.366 L 49.929 17.434 49.929 17.035 C 49.929 16.656,49.964 16.620,50.632 16.321 C 52.097 15.663,53.910 14.430,54.856 13.447 L 55.291 12.996 54.890 12.668 C 54.669 12.488,53.870 11.987,53.115 11.556 L 51.741 10.771 50.732 11.847 C 49.009 13.682,46.936 15.200,44.527 16.388 C 42.414 17.429,42.646 17.401,36.208 17.401 L 30.610 17.401 30.347 16.875 C 29.241 14.661,25.552 14.624,24.855 16.820 C 24.701 17.306,21.655 16.338,19.995 15.277 L 19.461 14.936 17.948 15.686 C 15.683 16.808,12.338 17.856,11.020 17.856 C 10.720 17.856,10.691 17.891,10.691 18.252 C 10.691 18.689,10.705 18.696,11.797 18.820 C 13.073 18.964,15.879 19.944,18.222 21.064 L 19.441 21.646 20.060 21.236 C 20.810 20.738,21.633 20.388,23.170 19.915 C 23.809 19.719,24.400 19.531,24.484 19.499 C 24.577 19.464,24.777 19.657,24.997 19.996 C 26.298 22.004,29.356 21.857,30.351 19.740 L 30.595 19.221 36.342 19.221 C 41.839 19.221,42.119 19.231,42.782 19.455 C 45.342 20.317,49.559 23.216,51.214 25.251 L 51.675 25.817 52.309 25.463 C 53.518 24.788,54.650 24.095,54.979 23.830 L 55.309 23.563 54.592 22.899 C 53.331 21.731,51.733 20.675,50.470 20.174 C 49.975 19.978,49.930 19.928,49.929 19.576 L 49.929 19.191 51.436 19.249 C 53.519 19.328,55.410 19.958,57.219 21.175 L 57.969 21.679 58.812 21.319 C 60.098 20.771,60.976 20.238,61.177 19.884 L 61.359 19.564 202.525 19.563 L 343.691 19.562 344.221 19.920 C 344.513 20.117,345.237 20.492,345.830 20.753 L 346.908 21.227 347.799 20.641 C 349.588 19.464,351.806 18.771,353.796 18.768 L 354.962 18.766 354.961 19.136 C 354.961 19.471,354.910 19.525,354.421 19.719 C 353.724 19.996,352.333 20.797,351.595 21.348 C 350.984 21.804,349.616 23.037,349.616 23.132 C 349.616 23.223,351.426 24.383,352.356 24.889 L 353.219 25.358 353.678 24.794 C 355.332 22.761,359.550 19.862,362.108 19.000 C 362.772 18.776,363.052 18.766,368.549 18.766 L 374.295 18.766 374.541 19.290 C 375.528 21.388,378.596 21.545,379.880 19.562 C 380.199 19.070,380.264 19.025,380.535 19.104 C 383.054 19.842,383.936 20.187,384.831 20.781 L 385.449 21.191 386.668 20.609 C 389.069 19.462,391.773 18.524,393.126 18.370 C 394.164 18.251,394.200 18.232,394.200 17.792 C 394.200 17.437,394.169 17.401,393.871 17.401 C 392.553 17.401,389.207 16.353,386.943 15.231 L 385.429 14.481 384.895 14.822 C 383.236 15.883,380.190 16.851,380.036 16.365 C 379.339 14.169,375.649 14.206,374.543 16.420 L 374.280 16.946 368.682 16.946 C 362.245 16.946,362.477 16.975,360.364 15.933 C 357.963 14.749,355.881 13.227,354.175 11.409 C 353.628 10.826,353.159 10.350,353.133 10.350 C 353.106 10.350,352.483 10.696,351.747 11.118 M366.307 21.576 C 366.447 21.603,366.678 21.603,366.818 21.576 C 366.959 21.549,366.844 21.527,366.562 21.527 C 366.281 21.527,366.166 21.549,366.307 21.576 M343.588 25.192 C 343.800 25.411,344.000 25.590,344.031 25.590 C 344.062 25.590,343.914 25.411,343.702 25.192 C 343.490 24.973,343.291 24.794,343.259 24.794 C 343.228 24.794,343.376 24.973,343.588 25.192 M340.404 24.939 C 340.404 24.956,340.800 25.353,341.285 25.820 L 342.167 26.670 341.316 25.789 C 340.527 24.970,340.404 24.856,340.404 24.939 M362.440 25.102 C 362.580 25.129,362.811 25.129,362.951 25.102 C 363.092 25.074,362.977 25.052,362.695 25.052 C 362.414 25.052,362.299 25.074,362.440 25.102 M372.931 26.443 C 373.271 26.787,373.575 27.069,373.606 27.069 C 373.637 27.069,373.385 26.787,373.045 26.443 C 372.705 26.099,372.402 25.817,372.371 25.817 C 372.339 25.817,372.592 26.099,372.931 26.443 M368.977 29.229 C 368.977 29.448,369.001 29.538,369.029 29.428 C 369.058 29.319,369.058 29.140,369.029 29.030 C 369.001 28.921,368.977 29.011,368.977 29.229 M367.069 33.807 L 366.619 34.291 367.103 33.841 C 367.552 33.423,367.638 33.324,367.552 33.324 C 367.534 33.324,367.316 33.541,367.069 33.807 M360.904 36.132 C 361.014 36.160,361.193 36.160,361.302 36.132 C 361.412 36.103,361.322 36.080,361.103 36.080 C 360.884 36.080,360.795 36.103,360.904 36.132"/></g></svg>
+1
.github/images/line-break.svg
+1
.github/images/line-break.svg
···
1
+
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" id="svg" width="400" height="51.636" version="1.1" viewBox="0 0 400 51.636"><style>:root{--borderColor-muted:#363A4F}@media (prefers-color-scheme:light){:root{--borderColor-muted:#CCD0DA}}</style><g id="svgg"><path id="path0" fill="var(--borderColor-muted)" fill-rule="evenodd" stroke="none" d="M184.385 14.791 C 180.462 15.819,178.353 19.258,179.221 23.212 C 179.600 24.943,179.746 24.668,177.916 25.674 C 169.922 30.069,162.339 31.816,156.488 30.613 C 147.807 28.826,145.354 20.411,152.485 16.874 C 157.799 14.238,163.973 15.682,166.247 20.092 C 166.445 20.475,166.616 20.807,166.628 20.830 C 166.735 21.034,167.515 20.551,167.448 20.322 C 167.096 19.127,165.169 16.888,163.812 16.099 C 157.062 12.172,146.729 16.511,147.333 23.019 C 147.997 30.160,153.419 33.997,162.848 33.998 C 168.870 33.998,173.658 32.712,179.548 29.510 C 181.114 28.659,181.261 28.602,181.375 28.807 C 181.601 29.216,182.839 30.449,183.612 31.037 C 188.637 34.860,198.240 35.126,206.887 31.682 L 208.258 31.135 209.130 31.499 C 214.746 33.837,222.238 29.431,221.792 24.053 L 221.738 23.398 223.324 22.500 C 231.763 17.720,239.367 16.192,246.083 17.927 C 253.002 19.715,255.081 25.567,250.123 29.297 C 247.213 31.487,242.422 31.809,240.322 29.957 C 240.108 29.768,239.515 30.185,239.515 30.524 C 239.515 31.249,243.233 32.351,245.091 32.175 C 253.916 31.342,256.758 22.845,249.818 18.039 C 242.925 13.265,232.014 13.637,221.539 19.001 L 219.988 19.796 219.479 19.306 C 214.437 14.455,203.974 13.301,195.067 16.613 L 194.074 16.983 193.446 16.551 C 190.916 14.810,187.123 14.074,184.385 14.791 M189.364 15.753 C 190.446 16.042,191.426 16.453,192.328 16.997 L 192.959 17.378 191.964 17.822 C 189.547 18.903,187.339 20.101,182.367 23.031 C 181.435 23.579,180.608 24.053,180.530 24.083 C 180.312 24.167,180.000 22.596,180.000 21.413 C 180.000 17.066,184.377 14.420,189.364 15.753 M213.095 17.674 C 215.299 18.136,217.497 19.052,218.475 19.917 L 218.912 20.303 215.183 22.503 C 211.797 24.500,208.056 26.565,206.275 27.420 L 205.589 27.748 202.710 24.709 C 201.126 23.037,199.294 21.182,198.639 20.587 L 197.449 19.505 197.847 19.339 C 202.188 17.525,208.894 16.793,213.095 17.674 M198.280 21.690 C 199.216 22.530,204.662 28.231,204.588 28.295 C 204.565 28.315,204.082 28.500,203.515 28.705 C 194.788 31.866,187.238 31.642,182.986 28.096 L 182.639 27.807 184.562 26.648 C 185.620 26.011,187.630 24.792,189.030 23.939 C 190.430 23.087,192.664 21.855,193.994 21.202 L 196.412 20.015 196.903 20.455 C 197.173 20.697,197.793 21.253,198.280 21.690 M220.879 24.347 C 220.993 24.781,220.711 26.007,220.303 26.857 C 218.792 29.999,213.426 32.082,210.020 30.849 L 209.433 30.637 210.747 29.944 C 212.733 28.898,214.798 27.707,217.879 25.831 C 220.968 23.951,220.798 24.035,220.879 24.347 M4.000 25.273 L 4.000 26.303 73.697 26.303 L 143.394 26.303 143.394 25.273 L 143.394 24.242 73.697 24.242 L 4.000 24.242 4.000 25.273 M256.727 25.273 L 256.727 26.303 326.424 26.303 L 396.121 26.303 396.121 25.273 L 396.121 24.242 326.424 24.242 L 256.727 24.242 256.727 25.273"/></g></svg>
.github/images/transparent.png
.github/images/transparent.png
This is a binary file and will not be displayed.
+30
.github/workflows/cliff.yaml
+30
.github/workflows/cliff.yaml
···
1
+
name: Generate Changelog
2
+
on:
3
+
release:
4
+
types: [published]
5
+
branches: [master]
6
+
permissions:
7
+
contents: write
8
+
env:
9
+
GH_TOKEN: ${{ github.token }}
10
+
jobs:
11
+
generate_changelog:
12
+
runs-on: ubuntu-latest
13
+
name: Generate Changelog
14
+
steps:
15
+
- name: Check out repository
16
+
uses: actions/checkout@v3
17
+
with:
18
+
fetch-depth: 0
19
+
20
+
- name: Generate a changelog
21
+
uses: orhun/git-cliff-action@v3
22
+
with:
23
+
config: cliff.toml
24
+
args: --verbose --latest
25
+
env:
26
+
OUTPUT: CHANGELOG.md
27
+
GITHUB_REPO: ${{ github.repository }}
28
+
29
+
- name: Add changelog to release
30
+
run: gh release edit ${{ github.event.release.tag_name }} -F CHANGELOG.md
+26
CODE_OF_CONDUCT.md
+26
CODE_OF_CONDUCT.md
···
1
+
# Code Of Conduct
2
+
3
+
This Code of Conduct is based heavily on "instruments of good works" from chapter 4 of The Rule of St. Benedict (hereafter: "The Rule"). This Rule has proven its mettle in thousands of diverse communities for over 1,500 years, and has served as a baseline for many civil law codes since the time of Charlemagne.
4
+
5
+
The Rule is strict, and none are able to comply perfectly. Grace is readily granted for minor transgressions. All are encourage to follow this rule closely, as in so doing they may expect to live happier, healthier, and more productive lives. The entire Rule is good and wholesome, and yet we make no enforcement of the more introspective aspects.
6
+
7
+
We view The Rule as our promise to all users of this project of how the developers are expected to behave. This is a one-way promise, or covenant. In other words, the developers are saying: "We will treat you this way regardless of how you treat us." We ask you to join us in this covenant through your interactions with this project.
8
+
9
+
## 2. The Abbreviated Rule
10
+
11
+
1. Love the Lord God with all your heart, soul, mind, and strength.
12
+
1. Love your neighbor as yourself.
13
+
1. Do not steal or bear false witness.
14
+
1. Honor all people and treat them with the respect you desire.
15
+
1. Do not give way to anger or nurse grudges.
16
+
1. Speak truthfully and reject all forms of deceit.
17
+
1. Do not return evil for evil, and bear wrongs patiently. (that does not mean you must suffer abuse from others however)
18
+
1. Be humble, avoid pride, jealousy, and arrogance.
19
+
1. Respect the wisdom of those who are more experienced than you, recognizing that knowledge is earned through time and reflection.
20
+
1. Generously share your understanding with those who are still learning, approaching teaching with compassion, patience, and genuine care.
21
+
1. Settle disputes quickly and with care, ensuring that disagreements do not fester and grow beyond repair.
22
+
1. Never despair of mercy.
23
+
24
+
## 3. Attribution
25
+
26
+
This code of conduct was adapted from [The rule of St. Benedict, as your Code of Conduct](https://github.com/saint-benedict/code-of-conduct) which in turn was adapted from [SQLite's Code of conduct](https://web.archive.org/web/20181024103452/https://sqlite.org/codeofconduct.html) and now [Code of Ethics](https://sqlite.org/codeofethics.html).
+8
CONTRIBUTING.md
+8
CONTRIBUTING.md
···
1
+
# Contributing.md
2
+
3
+
Hi there! I'm glad you decided to add something! I don't have a super strict contributing guideline but here are some things to keep in mind:
4
+
5
+
1. Please try to follow the existing style of code and documentation. I know this seems kinda obvious but its easy enough to forget when implementing a new feature!
6
+
2. Follow the CoC please ๐ It should be linked on this repo's home page but if not you can find it [here](https://github.com/taciturnaxolotl/carriage/blob/master/.github/CODE_OF_CONDUCT.md). The TLDR is be nice and don't be a jerk but then again so is the TLDR of most CoCs :)
7
+
3. Use conventional commits! I'm a big fan of the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. It makes it easier to track changes and generate changelogs. I tend to use it at a pretty basic level (feat|chore|bug|docs: <message>) but feel free to get as fancy as you want within the standard ^-^
8
+
4. Last one. Once you open a PR ping me plz ๐ I tend to forget to check my repos for PRs so a ping will remind me it exists and i'll get to it much quicker! Alternatively you can open the PR and wait 4-6 business months ๐
+660
LICENSE.md
+660
LICENSE.md
···
1
+
# GNU AFFERO GENERAL PUBLIC LICENSE
2
+
3
+
Version 3, 19 November 2007
4
+
5
+
Copyright (C) 2007 Free Software Foundation, Inc.
6
+
<https://fsf.org/>
7
+
8
+
Everyone is permitted to copy and distribute verbatim copies of this
9
+
license document, but changing it is not allowed.
10
+
11
+
## Preamble
12
+
13
+
The GNU Affero General Public License is a free, copyleft license for
14
+
software and other kinds of works, specifically designed to ensure
15
+
cooperation with the community in the case of network server software.
16
+
17
+
The licenses for most software and other practical works are designed
18
+
to take away your freedom to share and change the works. By contrast,
19
+
our General Public Licenses are intended to guarantee your freedom to
20
+
share and change all versions of a program--to make sure it remains
21
+
free software for all its users.
22
+
23
+
When we speak of free software, we are referring to freedom, not
24
+
price. Our General Public Licenses are designed to make sure that you
25
+
have the freedom to distribute copies of free software (and charge for
26
+
them if you wish), that you receive source code or can get it if you
27
+
want it, that you can change the software or use pieces of it in new
28
+
free programs, and that you know you can do these things.
29
+
30
+
Developers that use our General Public Licenses protect your rights
31
+
with two steps: (1) assert copyright on the software, and (2) offer
32
+
you this License which gives you legal permission to copy, distribute
33
+
and/or modify the software.
34
+
35
+
A secondary benefit of defending all users' freedom is that
36
+
improvements made in alternate versions of the program, if they
37
+
receive widespread use, become available for other developers to
38
+
incorporate. Many developers of free software are heartened and
39
+
encouraged by the resulting cooperation. However, in the case of
40
+
software used on network servers, this result may fail to come about.
41
+
The GNU General Public License permits making a modified version and
42
+
letting the public access it on a server without ever releasing its
43
+
source code to the public.
44
+
45
+
The GNU Affero General Public License is designed specifically to
46
+
ensure that, in such cases, the modified source code becomes available
47
+
to the community. It requires the operator of a network server to
48
+
provide the source code of the modified version running there to the
49
+
users of that server. Therefore, public use of a modified version, on
50
+
a publicly accessible server, gives the public access to the source
51
+
code of the modified version.
52
+
53
+
An older license, called the Affero General Public License and
54
+
published by Affero, was designed to accomplish similar goals. This is
55
+
a different license, not a version of the Affero GPL, but Affero has
56
+
released a new version of the Affero GPL which permits relicensing
57
+
under this license.
58
+
59
+
The precise terms and conditions for copying, distribution and
60
+
modification follow.
61
+
62
+
## TERMS AND CONDITIONS
63
+
64
+
### 0. Definitions.
65
+
66
+
"This License" refers to version 3 of the GNU Affero General Public
67
+
License.
68
+
69
+
"Copyright" also means copyright-like laws that apply to other kinds
70
+
of works, such as semiconductor masks.
71
+
72
+
"The Program" refers to any copyrightable work licensed under this
73
+
License. Each licensee is addressed as "you". "Licensees" and
74
+
"recipients" may be individuals or organizations.
75
+
76
+
To "modify" a work means to copy from or adapt all or part of the work
77
+
in a fashion requiring copyright permission, other than the making of
78
+
an exact copy. The resulting work is called a "modified version" of
79
+
the earlier work or a work "based on" the earlier work.
80
+
81
+
A "covered work" means either the unmodified Program or a work based
82
+
on the Program.
83
+
84
+
To "propagate" a work means to do anything with it that, without
85
+
permission, would make you directly or secondarily liable for
86
+
infringement under applicable copyright law, except executing it on a
87
+
computer or modifying a private copy. Propagation includes copying,
88
+
distribution (with or without modification), making available to the
89
+
public, and in some countries other activities as well.
90
+
91
+
To "convey" a work means any kind of propagation that enables other
92
+
parties to make or receive copies. Mere interaction with a user
93
+
through a computer network, with no transfer of a copy, is not
94
+
conveying.
95
+
96
+
An interactive user interface displays "Appropriate Legal Notices" to
97
+
the extent that it includes a convenient and prominently visible
98
+
feature that (1) displays an appropriate copyright notice, and (2)
99
+
tells the user that there is no warranty for the work (except to the
100
+
extent that warranties are provided), that licensees may convey the
101
+
work under this License, and how to view a copy of this License. If
102
+
the interface presents a list of user commands or options, such as a
103
+
menu, a prominent item in the list meets this criterion.
104
+
105
+
### 1. Source Code.
106
+
107
+
The "source code" for a work means the preferred form of the work for
108
+
making modifications to it. "Object code" means any non-source form of
109
+
a work.
110
+
111
+
A "Standard Interface" means an interface that either is an official
112
+
standard defined by a recognized standards body, or, in the case of
113
+
interfaces specified for a particular programming language, one that
114
+
is widely used among developers working in that language.
115
+
116
+
The "System Libraries" of an executable work include anything, other
117
+
than the work as a whole, that (a) is included in the normal form of
118
+
packaging a Major Component, but which is not part of that Major
119
+
Component, and (b) serves only to enable use of the work with that
120
+
Major Component, or to implement a Standard Interface for which an
121
+
implementation is available to the public in source code form. A
122
+
"Major Component", in this context, means a major essential component
123
+
(kernel, window system, and so on) of the specific operating system
124
+
(if any) on which the executable work runs, or a compiler used to
125
+
produce the work, or an object code interpreter used to run it.
126
+
127
+
The "Corresponding Source" for a work in object code form means all
128
+
the source code needed to generate, install, and (for an executable
129
+
work) run the object code and to modify the work, including scripts to
130
+
control those activities. However, it does not include the work's
131
+
System Libraries, or general-purpose tools or generally available free
132
+
programs which are used unmodified in performing those activities but
133
+
which are not part of the work. For example, Corresponding Source
134
+
includes interface definition files associated with source files for
135
+
the work, and the source code for shared libraries and dynamically
136
+
linked subprograms that the work is specifically designed to require,
137
+
such as by intimate data communication or control flow between those
138
+
subprograms and other parts of the work.
139
+
140
+
The Corresponding Source need not include anything that users can
141
+
regenerate automatically from other parts of the Corresponding Source.
142
+
143
+
The Corresponding Source for a work in source code form is that same
144
+
work.
145
+
146
+
### 2. Basic Permissions.
147
+
148
+
All rights granted under this License are granted for the term of
149
+
copyright on the Program, and are irrevocable provided the stated
150
+
conditions are met. This License explicitly affirms your unlimited
151
+
permission to run the unmodified Program. The output from running a
152
+
covered work is covered by this License only if the output, given its
153
+
content, constitutes a covered work. This License acknowledges your
154
+
rights of fair use or other equivalent, as provided by copyright law.
155
+
156
+
You may make, run and propagate covered works that you do not convey,
157
+
without conditions so long as your license otherwise remains in force.
158
+
You may convey covered works to others for the sole purpose of having
159
+
them make modifications exclusively for you, or provide you with
160
+
facilities for running those works, provided that you comply with the
161
+
terms of this License in conveying all material for which you do not
162
+
control copyright. Those thus making or running the covered works for
163
+
you must do so exclusively on your behalf, under your direction and
164
+
control, on terms that prohibit them from making any copies of your
165
+
copyrighted material outside their relationship with you.
166
+
167
+
Conveying under any other circumstances is permitted solely under the
168
+
conditions stated below. Sublicensing is not allowed; section 10 makes
169
+
it unnecessary.
170
+
171
+
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
172
+
173
+
No covered work shall be deemed part of an effective technological
174
+
measure under any applicable law fulfilling obligations under article
175
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
176
+
similar laws prohibiting or restricting circumvention of such
177
+
measures.
178
+
179
+
When you convey a covered work, you waive any legal power to forbid
180
+
circumvention of technological measures to the extent such
181
+
circumvention is effected by exercising rights under this License with
182
+
respect to the covered work, and you disclaim any intention to limit
183
+
operation or modification of the work as a means of enforcing, against
184
+
the work's users, your or third parties' legal rights to forbid
185
+
circumvention of technological measures.
186
+
187
+
### 4. Conveying Verbatim Copies.
188
+
189
+
You may convey verbatim copies of the Program's source code as you
190
+
receive it, in any medium, provided that you conspicuously and
191
+
appropriately publish on each copy an appropriate copyright notice;
192
+
keep intact all notices stating that this License and any
193
+
non-permissive terms added in accord with section 7 apply to the code;
194
+
keep intact all notices of the absence of any warranty; and give all
195
+
recipients a copy of this License along with the Program.
196
+
197
+
You may charge any price or no price for each copy that you convey,
198
+
and you may offer support or warranty protection for a fee.
199
+
200
+
### 5. Conveying Modified Source Versions.
201
+
202
+
You may convey a work based on the Program, or the modifications to
203
+
produce it from the Program, in the form of source code under the
204
+
terms of section 4, provided that you also meet all of these
205
+
conditions:
206
+
207
+
- a) The work must carry prominent notices stating that you modified
208
+
it, and giving a relevant date.
209
+
- b) The work must carry prominent notices stating that it is
210
+
released under this License and any conditions added under
211
+
section 7. This requirement modifies the requirement in section 4
212
+
to "keep intact all notices".
213
+
- c) You must license the entire work, as a whole, under this
214
+
License to anyone who comes into possession of a copy. This
215
+
License will therefore apply, along with any applicable section 7
216
+
additional terms, to the whole of the work, and all its parts,
217
+
regardless of how they are packaged. This License gives no
218
+
permission to license the work in any other way, but it does not
219
+
invalidate such permission if you have separately received it.
220
+
- d) If the work has interactive user interfaces, each must display
221
+
Appropriate Legal Notices; however, if the Program has interactive
222
+
interfaces that do not display Appropriate Legal Notices, your
223
+
work need not make them do so.
224
+
225
+
A compilation of a covered work with other separate and independent
226
+
works, which are not by their nature extensions of the covered work,
227
+
and which are not combined with it such as to form a larger program,
228
+
in or on a volume of a storage or distribution medium, is called an
229
+
"aggregate" if the compilation and its resulting copyright are not
230
+
used to limit the access or legal rights of the compilation's users
231
+
beyond what the individual works permit. Inclusion of a covered work
232
+
in an aggregate does not cause this License to apply to the other
233
+
parts of the aggregate.
234
+
235
+
### 6. Conveying Non-Source Forms.
236
+
237
+
You may convey a covered work in object code form under the terms of
238
+
sections 4 and 5, provided that you also convey the machine-readable
239
+
Corresponding Source under the terms of this License, in one of these
240
+
ways:
241
+
242
+
- a) Convey the object code in, or embodied in, a physical product
243
+
(including a physical distribution medium), accompanied by the
244
+
Corresponding Source fixed on a durable physical medium
245
+
customarily used for software interchange.
246
+
- b) Convey the object code in, or embodied in, a physical product
247
+
(including a physical distribution medium), accompanied by a
248
+
written offer, valid for at least three years and valid for as
249
+
long as you offer spare parts or customer support for that product
250
+
model, to give anyone who possesses the object code either (1) a
251
+
copy of the Corresponding Source for all the software in the
252
+
product that is covered by this License, on a durable physical
253
+
medium customarily used for software interchange, for a price no
254
+
more than your reasonable cost of physically performing this
255
+
conveying of source, or (2) access to copy the Corresponding
256
+
Source from a network server at no charge.
257
+
- c) Convey individual copies of the object code with a copy of the
258
+
written offer to provide the Corresponding Source. This
259
+
alternative is allowed only occasionally and noncommercially, and
260
+
only if you received the object code with such an offer, in accord
261
+
with subsection 6b.
262
+
- d) Convey the object code by offering access from a designated
263
+
place (gratis or for a charge), and offer equivalent access to the
264
+
Corresponding Source in the same way through the same place at no
265
+
further charge. You need not require recipients to copy the
266
+
Corresponding Source along with the object code. If the place to
267
+
copy the object code is a network server, the Corresponding Source
268
+
may be on a different server (operated by you or a third party)
269
+
that supports equivalent copying facilities, provided you maintain
270
+
clear directions next to the object code saying where to find the
271
+
Corresponding Source. Regardless of what server hosts the
272
+
Corresponding Source, you remain obligated to ensure that it is
273
+
available for as long as needed to satisfy these requirements.
274
+
- e) Convey the object code using peer-to-peer transmission,
275
+
provided you inform other peers where the object code and
276
+
Corresponding Source of the work are being offered to the general
277
+
public at no charge under subsection 6d.
278
+
279
+
A separable portion of the object code, whose source code is excluded
280
+
from the Corresponding Source as a System Library, need not be
281
+
included in conveying the object code work.
282
+
283
+
A "User Product" is either (1) a "consumer product", which means any
284
+
tangible personal property which is normally used for personal,
285
+
family, or household purposes, or (2) anything designed or sold for
286
+
incorporation into a dwelling. In determining whether a product is a
287
+
consumer product, doubtful cases shall be resolved in favor of
288
+
coverage. For a particular product received by a particular user,
289
+
"normally used" refers to a typical or common use of that class of
290
+
product, regardless of the status of the particular user or of the way
291
+
in which the particular user actually uses, or expects or is expected
292
+
to use, the product. A product is a consumer product regardless of
293
+
whether the product has substantial commercial, industrial or
294
+
non-consumer uses, unless such uses represent the only significant
295
+
mode of use of the product.
296
+
297
+
"Installation Information" for a User Product means any methods,
298
+
procedures, authorization keys, or other information required to
299
+
install and execute modified versions of a covered work in that User
300
+
Product from a modified version of its Corresponding Source. The
301
+
information must suffice to ensure that the continued functioning of
302
+
the modified object code is in no case prevented or interfered with
303
+
solely because modification has been made.
304
+
305
+
If you convey an object code work under this section in, or with, or
306
+
specifically for use in, a User Product, and the conveying occurs as
307
+
part of a transaction in which the right of possession and use of the
308
+
User Product is transferred to the recipient in perpetuity or for a
309
+
fixed term (regardless of how the transaction is characterized), the
310
+
Corresponding Source conveyed under this section must be accompanied
311
+
by the Installation Information. But this requirement does not apply
312
+
if neither you nor any third party retains the ability to install
313
+
modified object code on the User Product (for example, the work has
314
+
been installed in ROM).
315
+
316
+
The requirement to provide Installation Information does not include a
317
+
requirement to continue to provide support service, warranty, or
318
+
updates for a work that has been modified or installed by the
319
+
recipient, or for the User Product in which it has been modified or
320
+
installed. Access to a network may be denied when the modification
321
+
itself materially and adversely affects the operation of the network
322
+
or violates the rules and protocols for communication across the
323
+
network.
324
+
325
+
Corresponding Source conveyed, and Installation Information provided,
326
+
in accord with this section must be in a format that is publicly
327
+
documented (and with an implementation available to the public in
328
+
source code form), and must require no special password or key for
329
+
unpacking, reading or copying.
330
+
331
+
### 7. Additional Terms.
332
+
333
+
"Additional permissions" are terms that supplement the terms of this
334
+
License by making exceptions from one or more of its conditions.
335
+
Additional permissions that are applicable to the entire Program shall
336
+
be treated as though they were included in this License, to the extent
337
+
that they are valid under applicable law. If additional permissions
338
+
apply only to part of the Program, that part may be used separately
339
+
under those permissions, but the entire Program remains governed by
340
+
this License without regard to the additional permissions.
341
+
342
+
When you convey a copy of a covered work, you may at your option
343
+
remove any additional permissions from that copy, or from any part of
344
+
it. (Additional permissions may be written to require their own
345
+
removal in certain cases when you modify the work.) You may place
346
+
additional permissions on material, added by you to a covered work,
347
+
for which you have or can give appropriate copyright permission.
348
+
349
+
Notwithstanding any other provision of this License, for material you
350
+
add to a covered work, you may (if authorized by the copyright holders
351
+
of that material) supplement the terms of this License with terms:
352
+
353
+
- a) Disclaiming warranty or limiting liability differently from the
354
+
terms of sections 15 and 16 of this License; or
355
+
- b) Requiring preservation of specified reasonable legal notices or
356
+
author attributions in that material or in the Appropriate Legal
357
+
Notices displayed by works containing it; or
358
+
- c) Prohibiting misrepresentation of the origin of that material,
359
+
or requiring that modified versions of such material be marked in
360
+
reasonable ways as different from the original version; or
361
+
- d) Limiting the use for publicity purposes of names of licensors
362
+
or authors of the material; or
363
+
- e) Declining to grant rights under trademark law for use of some
364
+
trade names, trademarks, or service marks; or
365
+
- f) Requiring indemnification of licensors and authors of that
366
+
material by anyone who conveys the material (or modified versions
367
+
of it) with contractual assumptions of liability to the recipient,
368
+
for any liability that these contractual assumptions directly
369
+
impose on those licensors and authors.
370
+
371
+
All other non-permissive additional terms are considered "further
372
+
restrictions" within the meaning of section 10. If the Program as you
373
+
received it, or any part of it, contains a notice stating that it is
374
+
governed by this License along with a term that is a further
375
+
restriction, you may remove that term. If a license document contains
376
+
a further restriction but permits relicensing or conveying under this
377
+
License, you may add to a covered work material governed by the terms
378
+
of that license document, provided that the further restriction does
379
+
not survive such relicensing or conveying.
380
+
381
+
If you add terms to a covered work in accord with this section, you
382
+
must place, in the relevant source files, a statement of the
383
+
additional terms that apply to those files, or a notice indicating
384
+
where to find the applicable terms.
385
+
386
+
Additional terms, permissive or non-permissive, may be stated in the
387
+
form of a separately written license, or stated as exceptions; the
388
+
above requirements apply either way.
389
+
390
+
### 8. Termination.
391
+
392
+
You may not propagate or modify a covered work except as expressly
393
+
provided under this License. Any attempt otherwise to propagate or
394
+
modify it is void, and will automatically terminate your rights under
395
+
this License (including any patent licenses granted under the third
396
+
paragraph of section 11).
397
+
398
+
However, if you cease all violation of this License, then your license
399
+
from a particular copyright holder is reinstated (a) provisionally,
400
+
unless and until the copyright holder explicitly and finally
401
+
terminates your license, and (b) permanently, if the copyright holder
402
+
fails to notify you of the violation by some reasonable means prior to
403
+
60 days after the cessation.
404
+
405
+
Moreover, your license from a particular copyright holder is
406
+
reinstated permanently if the copyright holder notifies you of the
407
+
violation by some reasonable means, this is the first time you have
408
+
received notice of violation of this License (for any work) from that
409
+
copyright holder, and you cure the violation prior to 30 days after
410
+
your receipt of the notice.
411
+
412
+
Termination of your rights under this section does not terminate the
413
+
licenses of parties who have received copies or rights from you under
414
+
this License. If your rights have been terminated and not permanently
415
+
reinstated, you do not qualify to receive new licenses for the same
416
+
material under section 10.
417
+
418
+
### 9. Acceptance Not Required for Having Copies.
419
+
420
+
You are not required to accept this License in order to receive or run
421
+
a copy of the Program. Ancillary propagation of a covered work
422
+
occurring solely as a consequence of using peer-to-peer transmission
423
+
to receive a copy likewise does not require acceptance. However,
424
+
nothing other than this License grants you permission to propagate or
425
+
modify any covered work. These actions infringe copyright if you do
426
+
not accept this License. Therefore, by modifying or propagating a
427
+
covered work, you indicate your acceptance of this License to do so.
428
+
429
+
### 10. Automatic Licensing of Downstream Recipients.
430
+
431
+
Each time you convey a covered work, the recipient automatically
432
+
receives a license from the original licensors, to run, modify and
433
+
propagate that work, subject to this License. You are not responsible
434
+
for enforcing compliance by third parties with this License.
435
+
436
+
An "entity transaction" is a transaction transferring control of an
437
+
organization, or substantially all assets of one, or subdividing an
438
+
organization, or merging organizations. If propagation of a covered
439
+
work results from an entity transaction, each party to that
440
+
transaction who receives a copy of the work also receives whatever
441
+
licenses to the work the party's predecessor in interest had or could
442
+
give under the previous paragraph, plus a right to possession of the
443
+
Corresponding Source of the work from the predecessor in interest, if
444
+
the predecessor has it or can get it with reasonable efforts.
445
+
446
+
You may not impose any further restrictions on the exercise of the
447
+
rights granted or affirmed under this License. For example, you may
448
+
not impose a license fee, royalty, or other charge for exercise of
449
+
rights granted under this License, and you may not initiate litigation
450
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
451
+
any patent claim is infringed by making, using, selling, offering for
452
+
sale, or importing the Program or any portion of it.
453
+
454
+
### 11. Patents.
455
+
456
+
A "contributor" is a copyright holder who authorizes use under this
457
+
License of the Program or a work on which the Program is based. The
458
+
work thus licensed is called the contributor's "contributor version".
459
+
460
+
A contributor's "essential patent claims" are all patent claims owned
461
+
or controlled by the contributor, whether already acquired or
462
+
hereafter acquired, that would be infringed by some manner, permitted
463
+
by this License, of making, using, or selling its contributor version,
464
+
but do not include claims that would be infringed only as a
465
+
consequence of further modification of the contributor version. For
466
+
purposes of this definition, "control" includes the right to grant
467
+
patent sublicenses in a manner consistent with the requirements of
468
+
this License.
469
+
470
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
471
+
patent license under the contributor's essential patent claims, to
472
+
make, use, sell, offer for sale, import and otherwise run, modify and
473
+
propagate the contents of its contributor version.
474
+
475
+
In the following three paragraphs, a "patent license" is any express
476
+
agreement or commitment, however denominated, not to enforce a patent
477
+
(such as an express permission to practice a patent or covenant not to
478
+
sue for patent infringement). To "grant" such a patent license to a
479
+
party means to make such an agreement or commitment not to enforce a
480
+
patent against the party.
481
+
482
+
If you convey a covered work, knowingly relying on a patent license,
483
+
and the Corresponding Source of the work is not available for anyone
484
+
to copy, free of charge and under the terms of this License, through a
485
+
publicly available network server or other readily accessible means,
486
+
then you must either (1) cause the Corresponding Source to be so
487
+
available, or (2) arrange to deprive yourself of the benefit of the
488
+
patent license for this particular work, or (3) arrange, in a manner
489
+
consistent with the requirements of this License, to extend the patent
490
+
license to downstream recipients. "Knowingly relying" means you have
491
+
actual knowledge that, but for the patent license, your conveying the
492
+
covered work in a country, or your recipient's use of the covered work
493
+
in a country, would infringe one or more identifiable patents in that
494
+
country that you have reason to believe are valid.
495
+
496
+
If, pursuant to or in connection with a single transaction or
497
+
arrangement, you convey, or propagate by procuring conveyance of, a
498
+
covered work, and grant a patent license to some of the parties
499
+
receiving the covered work authorizing them to use, propagate, modify
500
+
or convey a specific copy of the covered work, then the patent license
501
+
you grant is automatically extended to all recipients of the covered
502
+
work and works based on it.
503
+
504
+
A patent license is "discriminatory" if it does not include within the
505
+
scope of its coverage, prohibits the exercise of, or is conditioned on
506
+
the non-exercise of one or more of the rights that are specifically
507
+
granted under this License. You may not convey a covered work if you
508
+
are a party to an arrangement with a third party that is in the
509
+
business of distributing software, under which you make payment to the
510
+
third party based on the extent of your activity of conveying the
511
+
work, and under which the third party grants, to any of the parties
512
+
who would receive the covered work from you, a discriminatory patent
513
+
license (a) in connection with copies of the covered work conveyed by
514
+
you (or copies made from those copies), or (b) primarily for and in
515
+
connection with specific products or compilations that contain the
516
+
covered work, unless you entered into that arrangement, or that patent
517
+
license was granted, prior to 28 March 2007.
518
+
519
+
Nothing in this License shall be construed as excluding or limiting
520
+
any implied license or other defenses to infringement that may
521
+
otherwise be available to you under applicable patent law.
522
+
523
+
### 12. No Surrender of Others' Freedom.
524
+
525
+
If conditions are imposed on you (whether by court order, agreement or
526
+
otherwise) that contradict the conditions of this License, they do not
527
+
excuse you from the conditions of this License. If you cannot convey a
528
+
covered work so as to satisfy simultaneously your obligations under
529
+
this License and any other pertinent obligations, then as a
530
+
consequence you may not convey it at all. For example, if you agree to
531
+
terms that obligate you to collect a royalty for further conveying
532
+
from those to whom you convey the Program, the only way you could
533
+
satisfy both those terms and this License would be to refrain entirely
534
+
from conveying the Program.
535
+
536
+
### 13. Remote Network Interaction; Use with the GNU General Public License.
537
+
538
+
Notwithstanding any other provision of this License, if you modify the
539
+
Program, your modified version must prominently offer all users
540
+
interacting with it remotely through a computer network (if your
541
+
version supports such interaction) an opportunity to receive the
542
+
Corresponding Source of your version by providing access to the
543
+
Corresponding Source from a network server at no charge, through some
544
+
standard or customary means of facilitating copying of software. This
545
+
Corresponding Source shall include the Corresponding Source for any
546
+
work covered by version 3 of the GNU General Public License that is
547
+
incorporated pursuant to the following paragraph.
548
+
549
+
Notwithstanding any other provision of this License, you have
550
+
permission to link or combine any covered work with a work licensed
551
+
under version 3 of the GNU General Public License into a single
552
+
combined work, and to convey the resulting work. The terms of this
553
+
License will continue to apply to the part which is the covered work,
554
+
but the work with which it is combined will remain governed by version
555
+
3 of the GNU General Public License.
556
+
557
+
### 14. Revised Versions of this License.
558
+
559
+
The Free Software Foundation may publish revised and/or new versions
560
+
of the GNU Affero General Public License from time to time. Such new
561
+
versions will be similar in spirit to the present version, but may
562
+
differ in detail to address new problems or concerns.
563
+
564
+
Each version is given a distinguishing version number. If the Program
565
+
specifies that a certain numbered version of the GNU Affero General
566
+
Public License "or any later version" applies to it, you have the
567
+
option of following the terms and conditions either of that numbered
568
+
version or of any later version published by the Free Software
569
+
Foundation. If the Program does not specify a version number of the
570
+
GNU Affero General Public License, you may choose any version ever
571
+
published by the Free Software Foundation.
572
+
573
+
If the Program specifies that a proxy can decide which future versions
574
+
of the GNU Affero General Public License can be used, that proxy's
575
+
public statement of acceptance of a version permanently authorizes you
576
+
to choose that version for the Program.
577
+
578
+
Later license versions may give you additional or different
579
+
permissions. However, no additional obligations are imposed on any
580
+
author or copyright holder as a result of your choosing to follow a
581
+
later version.
582
+
583
+
### 15. Disclaimer of Warranty.
584
+
585
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
586
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
587
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
588
+
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
589
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
590
+
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
591
+
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
592
+
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
593
+
CORRECTION.
594
+
595
+
### 16. Limitation of Liability.
596
+
597
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
598
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
599
+
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
600
+
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
601
+
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
602
+
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
603
+
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
604
+
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
605
+
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
606
+
607
+
### 17. Interpretation of Sections 15 and 16.
608
+
609
+
If the disclaimer of warranty and limitation of liability provided
610
+
above cannot be given local legal effect according to their terms,
611
+
reviewing courts shall apply local law that most closely approximates
612
+
an absolute waiver of all civil liability in connection with the
613
+
Program, unless a warranty or assumption of liability accompanies a
614
+
copy of the Program in return for a fee.
615
+
616
+
END OF TERMS AND CONDITIONS
617
+
618
+
## How to Apply These Terms to Your New Programs
619
+
620
+
If you develop a new program, and you want it to be of the greatest
621
+
possible use to the public, the best way to achieve this is to make it
622
+
free software which everyone can redistribute and change under these
623
+
terms.
624
+
625
+
To do so, attach the following notices to the program. It is safest to
626
+
attach them to the start of each source file to most effectively state
627
+
the exclusion of warranty; and each file should have at least the
628
+
"copyright" line and a pointer to where the full notice is found.
629
+
630
+
<one line to give the program's name and a brief idea of what it does.>
631
+
Copyright (C) <year> <name of author>
632
+
633
+
This program is free software: you can redistribute it and/or modify
634
+
it under the terms of the GNU Affero General Public License as
635
+
published by the Free Software Foundation, either version 3 of the
636
+
License, or (at your option) any later version.
637
+
638
+
This program is distributed in the hope that it will be useful,
639
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
640
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
641
+
GNU Affero General Public License for more details.
642
+
643
+
You should have received a copy of the GNU Affero General Public License
644
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
645
+
646
+
Also add information on how to contact you by electronic and paper
647
+
mail.
648
+
649
+
If your software can interact with users remotely through a computer
650
+
network, you should also make sure that it provides a way for users to
651
+
get its source. For example, if your program is a web application, its
652
+
interface could display a "Source" link that leads users to an archive
653
+
of the code. There are many ways you could offer source, and different
654
+
solutions will be better for different programs; see section 13 for
655
+
the specific requirements.
656
+
657
+
You should also get your employer (if you work as a programmer) or
658
+
school, if any, to sign a "copyright disclaimer" for the program, if
659
+
necessary. For more information on this, and how to apply and follow
660
+
the GNU AGPL, see <https://www.gnu.org/licenses/>.
+34
README.md
+34
README.md
···
1
+
<h3 align="center">
2
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/carriage.webp" width="200" alt="Logo"/><br/>
3
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/transparent.png" height="45" width="0px"/>
4
+
<span>$$\Large \text{Carriage}$$</span>
5
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/transparent.png" height="30" width="0px"/>
6
+
</h3>
7
+
8
+
<p align="center">
9
+
<i>A train carriage can be anything you want it to be and is a container for storing things so that seems like an appropriate name</i>
10
+
</p>
11
+
12
+
<p align="center">
13
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break-thin.svg" />
14
+
</p>
15
+
16
+
## What's this?
17
+
18
+
This is my personal template repo! It serves as the reference for my `README.md` formating style and hopefully soon my license scheme.
19
+
20
+
## Why that License?
21
+
22
+
Well honestly i'm not quite sure myself. I've been currently looking into [Fair Source](https://fair.io/licenses/) licenses and the PolyForm [Small Business](https://polyformproject.org/licenses/small-business/1.0.0/) license to try and build a better default licensing scheme for my projects. As of now though I typically tend to use AGPL 3.0 as my default license. My main problem with it is that it doesn't provide a clear way for businesses to use the work commercially as most companies don't seem to want their proprietary modifications open source and public (for understandable reasons). Hopefully I can have a nice clear picture of how different licenses mash together and develop a nice clean system that continues to allow others to fork and modify my projects while giving me some kick back for large scale commercial use. Yes I know that isn't technically open source but it feels like a better way of balancing openness with commercialization.
23
+
24
+
<p align="center">
25
+
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break.svg" />
26
+
</p>
27
+
28
+
<p align="center">
29
+
© 2024-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas</a>
30
+
</p>
31
+
32
+
<p align="center">
33
+
<a href="https://github.com/taciturnaxolotl/carriage/blob/master/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=AGPL 3.0&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
34
+
</p>
+76
cliff.toml
+76
cliff.toml
···
1
+
# git-cliff ~ default configuration file
2
+
# https://git-cliff.org/docs/configuration
3
+
#
4
+
# Lines starting with "#" are comments.
5
+
# Configuration options are organized into tables and keys.
6
+
# See documentation for more information on available options.
7
+
8
+
[changelog]
9
+
# template for the changelog body
10
+
# https://keats.github.io/tera/docs/#introduction
11
+
body = """
12
+
# Changelog
13
+
14
+
{% if version %}\
15
+
**Full Commit Log**: <REPO>/commits/{{ version }}\n
16
+
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
17
+
{% else %}\
18
+
## [unreleased]
19
+
{% endif %}\
20
+
{% for group, commits in commits | group_by(attribute="group") %}
21
+
### {{ group | striptags | trim | upper_first }}
22
+
{% for commit in commits %}
23
+
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
24
+
{% if commit.breaking %}[**breaking**] {% endif %}\
25
+
{{ commit.message | upper_first }}\
26
+
{% endfor %}
27
+
{% endfor %}\n
28
+
"""
29
+
30
+
# remove the leading and trailing s
31
+
trim = true
32
+
# postprocessors
33
+
postprocessors = [
34
+
{ pattern = '<REPO>', replace = "https://github.com/taciturnaxolotl/carriage" }, # replace repository URL
35
+
]
36
+
37
+
[git]
38
+
# parse the commits based on https://www.conventionalcommits.org
39
+
conventional_commits = true
40
+
# filter out the commits that are not conventional
41
+
filter_unconventional = true
42
+
# process each line of a commit as an individual commit
43
+
split_commits = false
44
+
# regex for parsing and grouping commits
45
+
commit_parsers = [
46
+
{ message = "^feat", group = "<!-- 0 -->๐ Features" },
47
+
{ message = "^fix", group = "<!-- 1 -->๐ Bug Fixes" },
48
+
{ message = "^doc", group = "<!-- 3 -->๐ Documentation" },
49
+
{ message = "^perf", group = "<!-- 4 -->โก Performance" },
50
+
{ message = "^refactor", group = "<!-- 2 -->๐ Refactor" },
51
+
{ message = "^style", group = "<!-- 5 -->๐จ Styling" },
52
+
{ message = "^test", group = "<!-- 6 -->๐งช Testing" },
53
+
{ message = "^chore\\(release\\): prepare for", skip = true },
54
+
{ message = "^chore\\(deps.*\\)", skip = true },
55
+
{ message = "^chore\\(pr\\)", skip = true },
56
+
{ message = "^chore\\(pull\\)", skip = true },
57
+
{ message = "^chore|^ci", group = "<!-- 7 -->โ๏ธ Miscellaneous Tasks" },
58
+
{ body = ".*security", group = "<!-- 8 -->๐ก๏ธ Security" },
59
+
{ message = "^revert", group = "<!-- 9 -->โ๏ธ Revert" },
60
+
]
61
+
# protect breaking changes from being skipped due to matching a skipping commit_parser
62
+
protect_breaking_commits = false
63
+
# filter out the commits that are not matched by commit parsers
64
+
filter_commits = false
65
+
# regex for matching git tags
66
+
# tag_pattern = "v[0-9].*"
67
+
# regex for skipping tags
68
+
# skip_tags = ""
69
+
# regex for ignoring tags
70
+
# ignore_tags = ""
71
+
# sort the tags topologically
72
+
topo_order = false
73
+
# sort the commits inside sections by oldest/newest order
74
+
sort_commits = "oldest"
75
+
# limit the number of commits included in the changelog.
76
+
# limit_commits = 42