From c89c2df34dbf60dfff19e7eafba21f718a5bf7ce Mon Sep 17 00:00:00 2001 From: Jeremy Kescher Date: Wed, 27 Apr 2022 23:48:11 +0200 Subject: [PATCH] Add info about this fork --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 17 ++++++++--------- README.md | 23 ++++++++++++++--------- 3 files changed, 23 insertions(+), 19 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index cc0a7f51b0..4529bd2d82 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at glitch-abuse@sitedethib.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jeremy@kescher.at. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5b5513ff1..1fe0cb39f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,24 @@ -# Contributing to Mastodon Glitch Edition # +# Contributing to Mastodon catcatnya edition # -Thank you for your interest in contributing to the `glitch-soc` project! -Here are some guidelines, and ways you can help. +Thank you for your interest in contributing to a fork of the `glitch-soc` project! +Before you do anything here, please check if you can contribute to either the [vanilla Mastodon project](https://github.com/mastodon/mastodon) or [glitch-soc](https://github.com/glitch-soc/mastodon) first. +If you still decide to contribute here instead, here are some guidelines, and ways you can help. > (This document is a bit of a work-in-progress, so please bear with us. > If you don't see what you're looking for here, please don't hesitate to reach out!) ## Planning ## -Right now a lot of the planning for this project takes place in our development Discord, or through GitHub Issues and Projects. -We're working on ways to improve the planning structure and better solicit feedback, and if you feel like you can help in this respect, feel free to give us a holler. +Right now a lot of the planning for this project takes place... nowhere. Actually, just contact me via Matrix - contact info can be found on [my personal website](https://kescher.at). ## Documentation ## -The documentation for this repository is available at [`glitch-soc/docs`](https://github.com/glitch-soc/docs) (online at [glitch-soc.github.io/docs/](https://glitch-soc.github.io/docs/)). -Right now, we've mostly focused on the features that make this fork different from upstream in some manner. -Adding screenshots, improving descriptions, and so forth are all ways to help contribute to the project even if you don't know any code. +Unlike glitch-soc, which has [`glitch-soc/docs`](https://github.com/glitch-soc/docs) (online at [glitch-soc.github.io/docs/](https://glitch-soc.github.io/docs/)), this repo only documents things in a README. Sorry. +Right now, we've mostly focused on the features that make this fork different from upstream, which, may I remind you, is already a fork, in some manner. ## Frontend Development ## -Check out [the documentation here](https://glitch-soc.github.io/docs/contributing/frontend/) for more information. +Check out [the documentation here](https://glitch-soc.github.io/docs/contributing/frontend/) for more information on this topic. We'll be following that a bit. ## Backend Development ## diff --git a/README.md b/README.md index 256f2d2def..d08f25740d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ -# Mastodon Glitch Edition # +# Mastodon catcatnya~ edition -> Now with automated deploys! +## Introduction -[![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] +This Mastodon fork is based on the [glitch-soc Fork of Mastodon](https://github.com/glitch-soc/mastodon). -[circleci]: https://circleci.com/gh/glitch-soc/mastodon -[code_climate]: https://codeclimate.com/github/glitch-soc/mastodon +- To install, take a look at [glitch-soc.github.io/docs/](https://glitch-soc.github.io/docs/). The instructions and features are the same, except for the differences outlined below. +- Contributing guidelines are available [here](CONTRIBUTING.md). -So here's the deal: we all work on this code, and anyone who uses that does so absolutely at their own risk. can you dig it? +## Differences -- 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/). +- The favicon files are adjusted specifically for the catcatnya instance. Specifically, these: + - public/android-chrome-192x192.png + - public/apple-touch-icon.png + - public/browserconfig.xml + - public/favicon.ico + - public/mstile-150x150.png + You might want to revert these to the upstream files manually. +- TODO: Make more differences