Ryan/drop
1
0
Fork 0
mirror of https://github.com/Drop-OSS/drop.git synced 2025-11-09 20:12:10 +10:00
Code Issues Packages Projects Releases Wiki Activity

Some updates to README.md and CONTRIBUTING.md

Browse Source 
Signed-off-by: quexeky <git@quexeky.dev>
This commit is contained in:
quexeky
2024-11-04 21:59:12 +11:00
parent 9cb2d6d02f
commit e47944a3b0
2 changed files with 36 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,11 @@
# Contributing
Welcome! We're very happy to have people along with us to help creating Drop.
The best way to get started is by browsing our [GitHub Issues](https://github.com/Drop-OSS/drop/issues).
## Etiquette
It might not be the most enjoyable part, but we're trying to foster a good community around Drop.
1. **Be respectful**. We're all doing our best, so please, think before you say anything. Criticism is fine, welcome even. But don't go out of your way to make someone's day worse.
2. **Don't ping anyone without a reason**. People only have a limited amount of time in their day, so unless it's either urgent or very specific to someone, keep the pings down.
3. **Just use common sense**. If you wouldn't do it to another repo, then don't do it here. Any questions can be asked either in discussions or in the [discord](https://discord.gg/ZVGggfXN)

30
README.md
View File

@ -1,3 +1,24 @@
<div align="center">
<svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" width="30em">
<path
d="M4 13.5C4 11.0008 5.38798 8.76189 7.00766 7C8.43926 5.44272 10.0519 4.25811 11.0471 3.5959C11.6287 3.20893 12.3713 3.20893 12.9529 3.5959C13.9481 4.25811 15.5607 5.44272 16.9923 7C18.612 8.76189 20 11.0008 20 13.5C20 17.9183 16.4183 21.5 12 21.5C7.58172 21.5 4 17.9183 4 13.5Z"
stroke="#60a5fa" stroke-width="2" />
</svg>
</div>
<p align="center">
<a href="contributing.md">Contribution guide</a>&nbsp;&nbsp;&nbsp;
<a href="create-list.md">Creating a list</a>&nbsp;&nbsp;&nbsp;
<a href="https://deepcore.dev">Our website</a>&nbsp;&nbsp;&nbsp;
</p>
<br>
<br>
[![GitHub License](https://img.shields.io/github/license/Drop-OSS/drop-app)](LICENSE)
![Gitlab Pipeline Status](https://img.shields.io/gitlab/pipeline-status/drop-oss%2Fdrop?gitlab_url=https%3A%2F%2Flab.deepcore.dev)
[![Discord](https://img.shields.io/discord/1291622805124812871?label=discord)](https://discord.gg/ZVGggfXN)
[![Static Badge](https://img.shields.io/badge/contributions-welcome-blue)](https://github.com/Drop-OSS/drop/blob/main/README.md)
# Drop
Drop is an open-source game distribution platform, like GameVault or Steam. It's designed to distribute and shared DRM-free game quickly, all while being incredibly flexible, beautiful and fast.
@ -20,13 +41,12 @@ Drop uses a utility package called droplet that's written in Rust. It has builts
Steps:
1. Copy the `.env.example` to `.env` and add your GiantBomb metadata key (more metadata providers coming)
2. Create the `.data` directory with `mkdir .data`
3. Open up a terminal and navigate to `dev-tools`, and run `docker compose up`
4. Open up a terminal in the root directory of the project and run `yarn` and then `yarn dev` to start the dev server
3. Ensure that your user owns the `.data` directory with `sudo chown -R $(id -u $(whoami))`
4. Open up a terminal and navigate to `dev-tools`, and run `docker compose up`
5. Open up another terminal in the root directory of the project and run `yarn` and then `yarn dev` to start the dev server
To create an account:
Head over to the `/register` page. It's currently a temporary development form for creating a username + password log in.
## Contributing
Drop welcomes contributions! Just a couple of notes:
1. We use the Prettier formatter, so please format your code with that
2. Drop uses TailwindCSS `blue-600` and the `zinc` colours for monochrome
Please see the [in-depth contributing guide](https://github.com/Drop-OSS/drop/blob/main/CONTRIBUTING.md)