]> cat aescling's git repositories - mastodon.git/commitdiff
New README
authorkibigo! <marrus-sh@users.noreply.github.com>
Sun, 12 Sep 2021 05:40:33 +0000 (22:40 -0700)
committerkibigo! <marrus-sh@users.noreply.github.com>
Sun, 12 Sep 2021 05:40:33 +0000 (22:40 -0700)
• Removed ‹ README.md ›, which was the old GlitchSoc README.

• Added ‹ README.markdown ›, containing new README information.

README.markdown [new file with mode: 0644]
README.md [deleted file]

diff --git a/README.markdown b/README.markdown
new file mode 100644 (file)
index 0000000..1188f2d
--- /dev/null
@@ -0,0 +1,58 @@
+# Kibicat Mastodon
+
+__Kibicat Mastodon__ is a Mastodon‐compatible fediverse instance originally forked from <cite>Mastodon Glitch Edition</cite> (otherwise known as <cite>GlitchSoc</cite>).
+For an understanding of Mastodon and what it can do, see <https://joinmastodon.org>.
+
+The **goals** of Kibicat Mastodon are as follows :—
+
++ [Community‐oriented design approach](https://www.u2764.com/page05.xhtml), sensitive to the needs of [the 📟🐱 GlitchCat community](https://glitch.cat.family).
+
++ Increasing agency of users to make appropriate decisions through education and empowerment rather than mechanisms of control.
+
++ Standards compliance with relevant specifications, to the extent possible within the Mastodon ecosystem.
+
++ Readable, maintainable (in isolation, not necessarily as a fork) source code.
+
+Its **current priorities** are the following :—
+
+01. Increasing accessibility and usability of existing features of Mastodon.
+
+02. Improving documentation and deployment pipelines for the Mastodon software, making our work easier to replicate.
+
+03. Improving the extensibility, robustness, and interoperability of Mastodon; making the code less fragile and easier to maintain.
+
+04. Developing new features our users need.
+
+The following are **not goals** :—
+
++ Contributing to or improving other Mastodon‐compatible softwares (including upstream Mastodon).
+
+    + **Rationale:**
+    Kibicat Mastodon is not extensively funded and has limited developer resources.
+    We cannot afford to spend time packaging improvements for other, better‐funded implementations.
+    Our work is AGPL‐licensed; others are welcome to spend their own time and resources adapting our improvements.
+
++ Perpetually maintaining Kibicat Mastodon as a “soft” fork.
+
+    + **Rationale:**
+    Mastodon issues new releases extremely infrequently (a minor version every ∼6 mo).
+    There may come a time when it is easier for us to simply port over new features twice a year than it is for us to maintain perpetual pull‐and‐merge compatibility.
+    This said, for our own benefit, we will try to touch as little as we can in the process of meeting our goals.
+
+## Nomenclature
+
+Kibicat [ˌkʰɪbiˈkʰæt] Mastodon is the name of the software.
+This name reflects the fact that it is a fork of, and compatible with, the [Mastodon](https://joinmastodon.org) software developed by Mastodon gGmbH.
+(This name may change in the future if we decide that we no longer want to be associated with Mastodon gGmbH, or they decide they no longer want to be associated with us.)
+
+Kibicat may be abbreviated `🄺🐱`.
+
+Kibicat Mastodon has been developed primarily for use on the 📟🐱 GlitchCat *server*, hosted at <https://glitch.cat.family>.
+The software is not called GlitchCat.
+The software is called Kibicat Mastodon.
+
+## Contributing/Documentation/Etcetera
+
+Coming soon! In the meantime, contact [@Lady@cat.family](https://glitch.cat.family/@Lady).
+
+(For the most part, [documentation applicable to upstream Mastodon](https://docs.joinmastodon.org) is also applicable to Kibicat Mastodon.)
diff --git a/README.md b/README.md
deleted file mode 100644 (file)
index 02af634..0000000
--- a/README.md
+++ /dev/null
@@ -1,14 +0,0 @@
-#  Mastodon Glitch Edition  #
-
->   Now with automated deploys!
-
-[![Build Status](https://img.shields.io/circleci/project/github/glitch-soc/mastodon.svg)][circleci]
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/glitch-soc/mastodon.svg)][code_climate]
-
-[circleci]: https://circleci.com/gh/glitch-soc/mastodon
-[code_climate]: https://codeclimate.com/github/glitch-soc/mastodon
-
-So here's the deal: we all work on this code, and then it runs on dev.glitch.social and anyone who uses that does so absolutely at their own risk. can you dig it?
-
-- You can view documentation for this project at [glitch-soc.github.io/docs/](https://glitch-soc.github.io/docs/).
-- And contributing guidelines are available [here](CONTRIBUTING.md) and [here](https://glitch-soc.github.io/docs/contributing/).