atlas/README.md

61 lines
2.9 KiB
Markdown
Raw Normal View History

[![Entry count](https://img.shields.io/badge/dynamic/json?color=blue&label=entries&query=%24.length&url=https%3A%2F%2Fgithub.com%2FplaceAtlas%2Fatlas%2Fblob%2Fmaster%2Fweb%2Fatlas.json%3Fraw%3Dtrue)](https://place-atlas.stefanocoding.me/)
2022-04-07 12:52:11 +02:00
![Commit activity](https://img.shields.io/github/commit-activity/w/placeAtlas/atlas)
2022-04-07 15:40:12 +02:00
[![Netlify](https://img.shields.io/netlify/1e7291ce-0680-45ed-9843-47a32a992bbb?logo=netlify&logoColor=white)](https://app.netlify.com/sites/place-atlas/deploys)
2022-04-07 12:52:11 +02:00
[![License](https://img.shields.io/github/license/placeAtlas/atlas)](https://github.com/placeAtlas/atlas/blob/master/LICENSE)
[![Discord](https://img.shields.io/discord/960791635342524496?color=%235865F2&logo=discord&logoColor=white)](https://discord.gg/pJkm23b2nA)
[![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/placeAtlas2?color=%23FF4500&label=r%2FplaceAtlas2&logo=reddit&logoColor=white)](https://www.reddit.com/r/placeAtlas2/)
[![Website](https://img.shields.io/static/v1?label=website&message=place-atlas.stefanocoding.me&color=blue)](https://place-atlas.stefanocoding.me/)
# The 2022 Place Atlas
2022-04-07 12:52:11 +02:00
The /r/place Atlas is a project aiming to catalog all the artworks created during Reddit's 2022 /r/place event.
2019-03-04 10:58:04 +01:00
This project was created by Roland Rytz and is licensed under the GNU Affero General Public License v3.0.
2017-04-18 21:40:46 +02:00
---
2017-04-18 21:39:26 +02:00
*You can check out the website by clicking [here](https://place-atlas.stefanocoding.me/).*
2017-04-19 17:28:25 +02:00
If you don't know GitHub and wanted to submit new entries or request changes to existing ones, please visit [/r/placeAtlas2](https://www.reddit.com/r/placeAtlas2/).
2022-04-05 11:44:19 +02:00
## How To Contribute
2022-04-05 11:44:19 +02:00
### Map Contributions
2022-04-05 11:44:19 +02:00
**WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT!**
2022-04-05 11:44:19 +02:00
2022-04-05 17:16:18 +02:00
To contribute to the map, we require a certain format for artwork region and labels. This can be generated on the [contributing page](https://place-atlas.stefanocoding.me/index.html?mode=draw) on the website.
2022-04-05 11:44:19 +02:00
2022-04-24 10:33:21 +02:00
#### Reddit
2022-04-05 11:44:19 +02:00
2022-04-24 10:33:21 +02:00
1. Follow the instructions on the [contributing page](https://place-atlas.stefanocoding.me/index.html?mode=draw), then post it to Reddit by clicking "Post Direct to Reddit".
2022-04-05 11:44:19 +02:00
2. Flair your post with the "New Entry" tag.
3. A moderator will accept your contribution shortly.
<!--
2022-04-24 10:33:21 +02:00
#### GitHub
1. Create a fork of our repo.
2. Enter your data into the `web/_js/atlas.js` file, with the correct format and ID number.
3. Create a Pull Request.
-->
### Map Edits
2022-04-05 11:44:19 +02:00
2022-04-24 10:33:21 +02:00
#### Reddit
1. Click "Edit" on a entry and follow the instructions there, then post it to Reddit by clicking "Post Direct to Reddit".
2. Flair your post with the "Edit Entry" tag.
2022-04-24 10:33:21 +02:00
3. A moderator will accept your contribution shortly.
#### GitHub
2022-04-05 11:44:19 +02:00
1. Create a fork of our repo.
2022-04-06 15:30:11 +02:00
2. Enter your data into the `web/atlas.json` file, with the correct format and ID number.
3. Create a Pull Request against the `cleanup` branch.
2022-04-05 11:44:19 +02:00
### Cleaning Contributions
2022-04-05 11:44:19 +02:00
If you spot a duplicate, please PR against the `cleanup` branch. To help find duplicates, [use the Overlap mode](https://place-atlas.stefanocoding.me?mode=overlap).