android/finamp
1
0
Fork 0
mirror of https://github.com/jmshrv/finamp.git synced 2026-03-13 08:42:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

documentation improvements

Browse Source
This commit is contained in:
Chaphasilor
2025-03-28 23:52:13 +01:00
parent 23c7178749
commit 94ddc0a7a2
2 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -42,6 +42,17 @@ When creating new types, note that you'll also have to register an adapter in `m
The biggest main piece of work being done on Finamp at the moment is the redesign. The relevant issue can be found [here](https://github.com/jmshrv/finamp/issues/220). The `redesign` branch has diverged a lot from `main`, but I try to keep it updated. If you're struggling to decide what to work on, the redesign is a good place to look :)
## Designing
As the name implies, we'll need many fresh design mockups for the redesign. Some are already done, some are still being interated on, and some mockups haven't been started yet.
If you are a designer or have ideas on how the new user interface could/should look, then it would be amazing and really helpfull if you would create a mockup!
You can share your mockups in an issue here on GitHub (use a relevant one if possible, otherwise create a new one) or on Discord for further discussion.
Once the mockup is finalized, people can start implementing it.
There's also a Figma file with some existing mockups that you can go off of: <https://www.figma.com/design/wVizekpm9YchvHFP6l508r/Finamp?node-id=101-425&t=27CRT9QAwFhlIMqm-1>
Some of the designs in there are already outdated or still a work in progress. When in doubt, you should look at the current design in the actual app, or ask us about it!
## Translating
Finamp uses Weblate to manage translations: **https://hosted.weblate.org/engage/finamp/**

16
README.md
View File

@@ -1,5 +1,21 @@
![Banner](./GitHub_Banner.png)
## Finamplify - Finamp's First Hackathon!
From Saturday, March 29th (2025-03-29) until the end of Sunday, April 6th (2025-04-06), we are holding Finamp's first hackathon - called *Finamplify*.
This is 9 days of intensive work on Finamp, by new and existing contributors!
Here are the most important infos:
- The Hackathon is about making progress on Finamp's *redesign*, which is currently in beta.
Therefore, please **make sure to base your changes on the `redesign` branch when working on new features or fixes!**. We won't accept new features targeting the `main` branch, as the branches have diverged quite a bit.
- We would like to send out stickers to everyone who contributed to Finamp during this Hackathon! We'll mail the stickers to you for free, and this is entirely optional. Only significant contributions will be counted, so simply fixing a typo will not qualify you, sorry!
To send you the stickers we'll need your physical address. Here's a survey where you can enter your details: TODO
Please make sure to include your GitHub and/or Discord user name so we can ensure you actually contributed :)
- The Hackathon is happening here on GitHub and on our [Finamp Beta Testers Discord server](https://discord.gg/xh9SZ73jWk). Ideally you should participate on both platforms, but either works. For any *code contributions* you'll have to contribute on GitHub though, via a regular Pull Request. Design contributions a fine via Discord.
---
#### Redesign Beta
We're currently in the process of redesigning Finamp to transform it into a modern, beautiful, and feature-rich music player made specifically for Jellyfin.