atlas/README.md

44 lines
1.7 KiB
Markdown
Raw Normal View History

# The 2022 Place Atlas
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
#### Reddit Submission
2022-04-05 11:44:19 +02:00
1. Follow the instructions on the [contributing page](https://place-atlas.stefanocoding.me/index.html?mode=draw), then click "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.
<!--
#### GitHub Submission
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
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, append `?mode=overlap` to the url: [`https://place-atlas.stefanocoding.me?mode=overlap`](https://place-atlas.stefanocoding.me?mode=overlap).