Merge pull request #427 from SayaDuck/master

Readme edits for clarity & grammar, correct branch for duplicate, fix…
This commit is contained in:
Someone Somewhere 2022-04-05 18:18:10 +03:00 committed by GitHub
commit a09140b781
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,12 +1,12 @@
# The Place Atlas
The /r/place Atlas is a project aiming to catalog all the artworks created during Reddit's 2022's /r/place event.
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 at by clicking [here](https://place-atlas.stefanocoding.me/).*
*You can check out the website by clicking [here](https://place-atlas.stefanocoding.me/).*
To submit new entries or request changes to existing ones, please visist [/r/placeAtlas2](https://www.reddit.com/r/placeAtlas2/).
To submit new entries or request changes to existing ones, please visit [/r/placeAtlas2](https://www.reddit.com/r/placeAtlas2/).
# How To Contribute
@ -14,11 +14,11 @@ To submit new entries or request changes to existing ones, please visist [/r/pla
### 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](/index.html?mode=draw) on the website.
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](/index.html?mode=draw), then click "Post Direct to Reddit".
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.
@ -26,8 +26,8 @@ To contribute to the map, we require a certain format for artwork region and lab
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
3. Create a Pull Request against the `/cleanup` branch.
## Cleaning Contributions
If you spot a duplicate, please PR against `/cleaning`. To help find duplicates, run the code locally, changing line 92 of `main.js` to `overlap`.
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`.