atlas/README.md

[![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/)
![Commit activity](https://img.shields.io/github/commit-activity/w/placeAtlas/atlas)
[![Netlify](https://img.shields.io/netlify/1e7291ce-0680-45ed-9843-47a32a992bbb?logo=netlify&logoColor=white)](https://app.netlify.com/sites/place-atlas/deploys)
[![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

The /r/place Atlas is a project aiming to catalog all the artworks created during Reddit's 2022 /r/place event.
This project was created by Roland Rytz and is licensed under the GNU Affero General Public License v3.0.

---

*You can check out the website by clicking [here](https://place-atlas.stefanocoding.me/).*

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/).

## How To Contribute

### Map Contributions

**WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT!**

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. 

#### Reddit Submission

1. Follow the instructions on the [contributing page](https://place-atlas.stefanocoding.me/index.html?mode=draw), then click "Post Direct to Reddit".
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

1. Create a fork of our repo.
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.

### Cleaning Contributions

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).
Use "entries" instead of ambiguous "count" 2022-04-08 16:09:52 +02:00			`[![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/)`
Add README badges 2022-04-07 12:52:11 +02:00			`![Commit activity](https://img.shields.io/github/commit-activity/w/placeAtlas/atlas)`
Link Netlify button 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)`
Add README badges 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/)`

Change name to "The 2022 /r/place Atlas" 2022-04-05 17:53:01 +02:00			`# The 2022 Place Atlas`
Add README badges 2022-04-07 12:52:11 +02:00
Readme edits for clarity & grammar, correct branch for duplicate, fixed link 2022-04-05 17:14:11 +02:00			`The /r/place Atlas is a project aiming to catalog all the artworks created during Reddit's 2022 /r/place event.`
... fix my name 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.`
Create README.md Add a readme file to better explain the website to visitors. This also allows you to shorten up the description header! 2017-04-18 21:39:06 +02:00
Edit formatting on Readme 2017-04-18 21:40:46 +02:00			`---`
Update README.md 2017-04-18 21:39:26 +02:00
Readme edits for clarity & grammar, correct branch for duplicate, fixed link 2022-04-05 17:14:11 +02:00			`You can check out the website by clicking [here](https://place-atlas.stefanocoding.me/).`
Correct license to AGPL in README.md 2017-04-19 17:28:25 +02:00
README and CONTRIBUTING changes - Clarify message to go to r/placeatlas2 if don't know GitHub - Sync contents of CONTRIBUTING.md - Make heading levels correct, make notice in html so it won't be included in GitHub TOC - Add GitHub but commented for the time when GitHub additions are allowed 2022-04-05 17:47:05 +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/).`
Update README.md 2022-04-05 11:44:19 +02:00
README and CONTRIBUTING changes - Clarify message to go to r/placeatlas2 if don't know GitHub - Sync contents of CONTRIBUTING.md - Make heading levels correct, make notice in html so it won't be included in GitHub TOC - Add GitHub but commented for the time when GitHub additions are allowed 2022-04-05 17:47:05 +02:00			`## How To Contribute`
Update README.md 2022-04-05 11:44:19 +02:00
README and CONTRIBUTING changes - Clarify message to go to r/placeatlas2 if don't know GitHub - Sync contents of CONTRIBUTING.md - Make heading levels correct, make notice in html so it won't be included in GitHub TOC - Add GitHub but commented for the time when GitHub additions are allowed 2022-04-05 17:47:05 +02:00			`### Map Contributions`
Update README.md 2022-04-05 11:44:19 +02:00
Fix cleanup instructions & remove useless heading The cleanup instructions previously described manually editing the `main.js` file and gave a line number that is no longer correct. Furthermore, the `overlap` mode can be activated using a simple query parameter, no need for editing code ;) Also simplified the markup of the contribution warning. Using a heading is not just unnecessary as it doesn't produce any stylistic changes over bold text, but also adds a confusing heading entry to the table of contents. 2022-04-06 00:35:04 +02:00			`WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT!`
Update README.md 2022-04-05 11:44:19 +02:00
Fixed the other broken link 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.`
Update README.md 2022-04-05 11:44:19 +02:00
README and CONTRIBUTING changes - Clarify message to go to r/placeatlas2 if don't know GitHub - Sync contents of CONTRIBUTING.md - Make heading levels correct, make notice in html so it won't be included in GitHub TOC - Add GitHub but commented for the time when GitHub additions are allowed 2022-04-05 17:47:05 +02:00			`#### Reddit Submission`
Update README.md 2022-04-05 11:44:19 +02:00
Readme edits for clarity & grammar, correct branch for duplicate, fixed link 2022-04-05 17:14:11 +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".`
Update README.md 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.`

README and CONTRIBUTING changes - Clarify message to go to r/placeatlas2 if don't know GitHub - Sync contents of CONTRIBUTING.md - Make heading levels correct, make notice in html so it won't be included in GitHub TOC - Add GitHub but commented for the time when GitHub additions are allowed 2022-04-05 17:47:05 +02:00			`<!--`

			`#### 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`
Update README.md 2022-04-05 11:44:19 +02:00
			`1. Create a fork of our repo.`
Fix file path in README 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.
Sync CONTRIBUTING and remove slash before branch name 2022-04-06 10:30:33 +02:00			3. Create a Pull Request against the `cleanup` branch.
Update README.md 2022-04-05 11:44:19 +02:00
README and CONTRIBUTING changes - Clarify message to go to r/placeatlas2 if don't know GitHub - Sync contents of CONTRIBUTING.md - Make heading levels correct, make notice in html so it won't be included in GitHub TOC - Add GitHub but commented for the time when GitHub additions are allowed 2022-04-05 17:47:05 +02:00			`### Cleaning Contributions`
Update README.md 2022-04-05 11:44:19 +02:00
Sync CONTRIBUTING and remove slash before branch name 2022-04-06 10:30:33 +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).