diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dd66f94 --- /dev/null +++ b/CONTRIBUTING.md @@ -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) \ No newline at end of file diff --git a/README.md b/README.md index 3e960c6..3e02a62 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ +
+ + + +
+

+ Contribution guide    + Creating a list    + Our website    +

+
+
+ +[![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) \ No newline at end of file