From 41f55e5d8f5b532d26bb47619177bac26c8322cf Mon Sep 17 00:00:00 2001 From: Kouhai Date: Fri, 25 Nov 2022 22:03:05 -0600 Subject: [PATCH] update upstream glitch README/CONTRIBUTING --- CONTRIBUTING.md | 17 +++++++++++------ README.md | 24 +++++++++++++++--------- 2 files changed, 26 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 049cd4e29bd..b4454309e98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to Mastodon Glitch Edition # +# Contributing to Mastodon Glitch+Treehouse Edition # -Thank you for your interest in contributing to the `glitch-soc` project! +Thank you for your interest in contributing to the **Treehouse Mastodon** project! Here are some guidelines, and ways you can help. > (This document is a bit of a work-in-progress, so please bear with us. @@ -8,14 +8,19 @@ Here are some guidelines, and ways you can help. ## Planning ## -Right now a lot of the planning for this project takes place in our development Discord, or through GitHub Issues and Projects. +Right now a lot of the planning for this project takes place in the `#fediverse` +channel of the Treehouse Discord, or through Gitea Issues. + 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. ## 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. +The upstream Glitch 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/)). + +## Setup ## + +For a some-batteries-required guide to setting up a development environment for this repository, read Rin's excellent +[SETUP.md](https://gitea.treehouse.systems/treehouse/mastodon/src/branch/main/SETUP.md). ## Frontend Development ## diff --git a/README.md b/README.md index 256f2d2def1..c04e7430722 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@ -# Mastodon Glitch Edition # +# Mastodon Glitch+Treehouse Edition # -> Now with automated deploys! +> Now with bunny ears! -[![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] +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? -[circleci]: https://circleci.com/gh/glitch-soc/mastodon -[code_climate]: https://codeclimate.com/github/glitch-soc/mastodon +Specifically, this fork-of-a-fork is intended for Treehouse use only. Unless +otherwise communicated, we will not put effort into supporting other deployments +or upstreaming our patches. -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? +## Links -- 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/). +- You can view upstream Glitch's documentation for this project at [glitch-soc.github.io/docs/](https://glitch-soc.github.io/docs/). +- Contributing guidelines are available [here](CONTRIBUTING.md). + +## Known Deployments + +- Treehouse Social: [social.treehouse.systems](https://social.treehouse.systems) +- VT Social: [vt.social](https://vt.social) +- Unstable Systems: [unstable.systems](https://unstable.systems)