mirror of
https://github.com/placeAtlas/atlas.git
synced 2024-11-12 21:13:11 +01:00
7ac63b2edf
- 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
43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
# The 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
|
|
|
|
<h4><b>WE ONLY ACCEPT NEW CONTRIBUTIONS ON REDDIT</b></h4>
|
|
|
|
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/_js/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 `/cleanup`. To help find duplicates, run the code locally, changing line 92 of `main.js` to `overlap`.
|