From 3ff2d8f106f9fc2169970a3872d4643777410afc Mon Sep 17 00:00:00 2001 From: Levi Date: Thu, 17 Oct 2024 00:16:04 +0200 Subject: [PATCH] Update contribution instructions --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bbe692e..95fe1ff 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- logo + logo

# Titanic @@ -16,19 +16,24 @@ The main goal of this project was achieved. However, there are still a good amou ## Contributing You are welcome to make any kinds of suggestions or contributions to this project. -Feel free to contact me if you have any questions. +I would suggest starting by familiarizing yourself with the different kinds of external resources and APIs, that the codebase offers. +I have written a document about it [here](https://github.com/osuTitanic/common/blob/main/USAGE.md). +For large-scale changes you want to make, I'd suggest to contact me for further help and coordination. + +Although the project at this point is quite stable, there may be some outdated code that should have been refactored a while ago. +Please note that I've been working on this solo for about three years, so I am very happy when stuff just works. ## Credits -- All [testers](https://osu.titanic.sh/g/8) that somehow found the project through this GitHub repo and decided to register through Discord DMs +- All [testers](https://osu.titanic.sh/g/8) that somehow found the project through GitHub and decided to register through Discord DMs - Everyone that donated & contributed to this project (you guys are a big help!) - [Adachi](https://github.com/kanaarima/) for helping with the Discord bot & developing the pp system - Beatmap mirrors ([osu.direct](https://osu.direct/), [nerinyan](https://nerinyan.moe/) & [mino](https://catboy.best)) ## Screenshots -![sanic](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot007.jpg) -![cool](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot008.jpg) -![wow](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot023.jpg) -![nice](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot005.jpg) -![multiplayer](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot006.jpg) +![image](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot005.jpg) +![image](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot006.jpg) +![image](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot023.jpg) +![image](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot008.jpg) +![image](https://raw.githubusercontent.com/osuTitanic/titanic/main/.github/images/screenshot007.jpg)