atlas/README.md

93 lines
8.2 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/)
2022-10-04 00:47:33 +02:00
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
2022-10-08 13:03:34 +02:00
[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
2022-10-04 00:47:33 +02:00
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2022-04-26 10:00:25 +02:00
# The 2022 r/place Atlas
2022-04-07 12:52:11 +02:00
2022-04-26 10:00:25 +02:00
The 2022 r/place Atlas is a project aiming to catalog all the artworks created during Reddit's 2022 r/place event.
This project was established by Roland Rytz for the event in 2017, and further developed by Place Atlas team and contributors.
2017-04-18 21:39:26 +02:00
This project 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/).
2017-04-19 17:28:25 +02:00
2022-04-26 10:00: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
## Contributing
This project is open source. You may contribute to the project by submitting a Pull Request on the GitHub repo or send your submissions through Reddit. Other than than, you cau use Discord or Reddit for help.
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
2022-10-04 00:18:31 +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).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
2022-10-04 00:36:42 +02:00
<td align="center"><a href="https://stefanocoding.me"><img src="https://avatars.githubusercontent.com/u/25939526?v=4?s=100" width="100px;" alt="Stefano"/><br /><sub><b>Stefano</b></sub></a><br /><a href="#business-Codixer" title="Business development">💼</a> <a href="https://github.com/placeAtlas/atlas/commits?author=Codixer" title="Code">💻</a> <a href="#content-Codixer" title="Content">🖋</a> <a href="#data-Codixer" title="Data">🔣</a> <a href="#design-Codixer" title="Design">🎨</a> <a href="#fundingFinding-Codixer" title="Funding Finding">🔍</a> <a href="#infra-Codixer" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-Codixer" title="Maintenance">🚧</a> <a href="#projectManagement-Codixer" title="Project Management">📆</a> <a href="#question-Codixer" title="Answering Questions">💬</a> <a href="#security-Codixer" title="Security">🛡️</a></td>
2022-10-04 00:55:57 +02:00
<td align="center"><a href="https://www.imskyyc.xyz/"><img src="https://avatars.githubusercontent.com/u/48039776?v=4?s=100" width="100px;" alt="imskyyc"/><br /><sub><b>imskyyc</b></sub></a><br /><a href="#financial-imskyyc" title="Financial">💵</a> <a href="#ideas-imskyyc" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/ab-gh"><img src="https://avatars.githubusercontent.com/u/18347932?v=4?s=100" width="100px;" alt="ash"/><br /><sub><b>ash</b></sub></a><br /><a href="#business-ab-gh" title="Business development">💼</a> <a href="#content-ab-gh" title="Content">🖋</a> <a href="#data-ab-gh" title="Data">🔣</a> <a href="#projectManagement-ab-gh" title="Project Management">📆</a> <a href="https://github.com/placeAtlas/atlas/pulls?q=is%3Apr+reviewed-by%3Aab-gh" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://linktr.ee/aeywoo"><img src="https://avatars.githubusercontent.com/u/65846594?v=4?s=100" width="100px;" alt="Aeywoo"/><br /><sub><b>Aeywoo</b></sub></a><br /><a href="#business-Aeywoo" title="Business development">💼</a> <a href="https://github.com/placeAtlas/atlas/issues?q=author%3AAeywoo" title="Bug reports">🐛</a> <a href="#blog-Aeywoo" title="Blogposts">📝</a> <a href="#content-Aeywoo" title="Content">🖋</a> <a href="#maintenance-Aeywoo" title="Maintenance">🚧</a> <a href="#research-Aeywoo" title="Research">🔬</a></td>
2022-10-08 13:03:34 +02:00
<td align="center"><a href="https://www.linkedin.com/in/chenghanngan/"><img src="https://avatars.githubusercontent.com/u/6516839?v=4?s=100" width="100px;" alt="Cheng Hann Gan"/><br /><sub><b>Cheng Hann Gan</b></sub></a><br /><a href="#data-AnonymousRandomPerson" title="Data">🔣</a> <a href="#content-AnonymousRandomPerson" title="Content">🖋</a> <a href="#research-AnonymousRandomPerson" title="Research">🔬</a> <a href="https://github.com/placeAtlas/atlas/commits?author=AnonymousRandomPerson" title="Code">💻</a> <a href="https://github.com/placeAtlas/atlas/pulls?q=is%3Apr+reviewed-by%3AAnonymousRandomPerson" title="Reviewed Pull Requests">👀</a></td>
2022-10-04 00:55:57 +02:00
<td align="center"><a href="https://github.com/mxdanger"><img src="https://avatars.githubusercontent.com/u/32040254?v=4?s=100" width="100px;" alt="mxdanger"/><br /><sub><b>mxdanger</b></sub></a><br /><a href="https://github.com/placeAtlas/atlas/commits?author=mxdanger" title="Code">💻</a> <a href="#a11y-mxdanger" title="Accessibility">️️️️♿️</a> <a href="https://github.com/placeAtlas/atlas/issues?q=author%3Amxdanger" title="Bug reports">🐛</a> <a href="#design-mxdanger" title="Design">🎨</a> <a href="#ideas-mxdanger" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-mxdanger" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-mxdanger" title="Maintenance">🚧</a> <a href="#tool-mxdanger" title="Tools">🔧</a> <a href="#userTesting-mxdanger" title="User Testing">📓</a></td>
2022-10-08 13:03:34 +02:00
<td align="center"><a href="https://github.com/artillect"><img src="https://avatars.githubusercontent.com/u/8906201?v=4?s=100" width="100px;" alt="Riley"/><br /><sub><b>Riley</b></sub></a><br /><a href="#data-artillect" title="Data">🔣</a> <a href="#design-artillect" title="Design">🎨</a> <a href="https://github.com/placeAtlas/atlas/commits?author=artillect" title="Documentation">📖</a></td>
2022-10-04 00:18:31 +02:00
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
2022-10-04 00:47:33 +02:00
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!