├── .gitattributes
├── media
├── logo.ai
├── badge.ai
├── logo.png
├── mentioned-badge.sketch
├── readme.md
├── badge-flat2.svg
├── logo.svg
├── badge-flat.svg
├── mentioned-badge-flat.svg
├── badge.svg
└── mentioned-badge.svg
├── .github
└── funding.yml
├── .editorconfig
├── create-list.md
├── contributing.md
├── code-of-conduct.md
├── awesome.md
├── pull_request_template.md
└── readme.md
/.gitattributes:
--------------------------------------------------------------------------------
1 | * text=auto eol=lf
2 | *.ai binary
3 | readme.md merge=union
4 |
--------------------------------------------------------------------------------
/media/logo.ai:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/XenocodeRCE/awesome/master/media/logo.ai
--------------------------------------------------------------------------------
/media/badge.ai:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/XenocodeRCE/awesome/master/media/badge.ai
--------------------------------------------------------------------------------
/media/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/XenocodeRCE/awesome/master/media/logo.png
--------------------------------------------------------------------------------
/media/mentioned-badge.sketch:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/XenocodeRCE/awesome/master/media/mentioned-badge.sketch
--------------------------------------------------------------------------------
/.github/funding.yml:
--------------------------------------------------------------------------------
1 | github: sindresorhus
2 | open_collective: sindresorhus
3 | patreon: sindresorhus
4 | custom: https://sindresorhus.com/donate
5 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | indent_style = tab
5 | end_of_line = lf
6 | charset = utf-8
7 | trim_trailing_whitespace = true
8 | insert_final_newline = true
9 |
--------------------------------------------------------------------------------
/media/readme.md:
--------------------------------------------------------------------------------
1 | # Media
2 |
3 | ## Logo
4 |
5 | - Primary color: `#fc60a8`
6 | - Secondary color: `#494368`
7 | - Font: [`Orbitron`](https://fonts.google.com/specimen/Orbitron)
8 |
9 | You are free to use and modify the logo for your Awesome list or other usage.
10 |
--------------------------------------------------------------------------------
/media/badge-flat2.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/create-list.md:
--------------------------------------------------------------------------------
1 | # Creating Your Own List
2 |
3 | - Read the [awesome manifesto](awesome.md) and ensure your list complies.
4 | - Search this list before making a new one, as yours may be a duplicate. If it is, try and contribute to the best one instead of making your own.
5 | - Your awesome list should be named `awesome-list-name` and have the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge), a [license](awesome.md#choose-an-appropriate-license), and [contribution guidelines](awesome.md#include-contribution-guidelines). Adding a [code of conduct](http://contributor-covenant.org/) is also strongly recommended. You might find [this Yeoman generator](https://github.com/dar5hak/generator-awesome-list) useful.
6 | - **Wait at least 30 days after creating a list before submitting it, to give it a chance to mature.**
7 | - **Make sure you read the [list guidelines](pull_request_template.md) before submitting a pull request for your list to be added here.**
8 |
9 | Thanks for being awesome!
10 |
--------------------------------------------------------------------------------
/contributing.md:
--------------------------------------------------------------------------------
1 | # Contribution Guidelines
2 |
3 | Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
4 |
5 | ## Adding an awesome list
6 |
7 | Please ensure your pull request adheres to the [list guidelines](pull_request_template.md).
8 |
9 | ## Creating your own awesome list
10 |
11 | To create your own list, check out the [instructions](create-list.md).
12 |
13 | ## Adding something to an awesome list
14 |
15 | If you have something awesome to contribute to an awesome list, this is how you do it.
16 |
17 | You'll need a [GitHub account](https://github.com/join)!
18 |
19 | 1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
20 | 2. Click on the `readme.md` file: 
21 | 3. Now click on the edit icon. 
22 | 4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). 
23 | 5. Say why you're proposing the changes, and then click on "Propose file change". 
24 | 6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
25 |
26 | ## Updating your Pull Request
27 |
28 | Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.
29 |
30 | [Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
31 |
--------------------------------------------------------------------------------
/media/logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/media/badge-flat.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/code-of-conduct.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, gender identity and expression, level of experience,
9 | nationality, personal appearance, race, religion, or sexual identity and
10 | orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at sindresorhus@gmail.com. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at [http://contributor-covenant.org/version/1/4][version]
72 |
73 | [homepage]: http://contributor-covenant.org
74 | [version]: http://contributor-covenant.org/version/1/4/
75 |
--------------------------------------------------------------------------------
/awesome.md:
--------------------------------------------------------------------------------
1 | # The awesome manifesto
2 |
3 | If you want your list to be included on `awesome`, try to only include actual awesome stuff in your list. After all, it's a curation, not a collection.
4 |
5 | But **what is awesome?**
6 |
7 | ## Only awesome is awesome
8 |
9 | Research if the stuff you're including is actually awesome. Only put stuff on the list that you or another contributor can personally recommend. You should rather leave stuff out than include too much.
10 |
11 | ## Awesome badge
12 |
13 | This badge is for Awesome lists.
14 |
15 | [](https://awesome.re)
16 | [](https://awesome.re)
17 | [](https://awesome.re)
18 |
19 | Add an awesome badge to the top of your list, right next to the title. [Example](https://github.com/sindresorhus/awesome-nodejs). You can choose either the regular badge or the flat one.
20 |
21 | ```md
22 | [](https://awesome.re)
23 | [](https://awesome.re)
24 | [](https://awesome.re)
25 | ```
26 |
27 | *The badges should not be modified in any way.*
28 |
29 | ## Awesome mentioned badge
30 |
31 | This badge is for projects being mentioned in an Awesome list (**NOT for use in Awesome lists**). For example, the [Chalk](https://github.com/chalk/chalk) project could feature this badge because it's listed in [Awesome Node.js](https://github.com/sindresorhus/awesome-nodejs). It's totally optional for projects, but it's a nice way to show they've been featured in an Awesome list. You can choose either the regular badge or the flat one.
32 |
33 | [](https://awesome.re)
34 | [](https://awesome.re)
35 |
36 | **Fill in the placeholders (Name and URL):**
37 |
38 | ```md
39 | [](https://github.com/)
40 | [](https://github.com/)
41 | ```
42 |
43 | Example:
44 |
45 | ```md
46 | [](https://github.com/sindresorhus/awesome-nodejs)
47 | ```
48 |
49 | If you're an Awesome list maintainer, you could encourage projects in your list to add the badge.
50 |
51 | *The badges should not be modified in any way.*
52 |
53 | ## Comment on why something is awesome
54 |
55 | Apart from suggesting a particular item on your list, you should also inform your readers *why* it's on the list and how they will benefit from it.
56 |
57 | ## Make it clear what the list is about
58 |
59 | Have a succinct description at the top of your readme. Make sure your list covers a certain scope and nothing else. Link to other awesome lists if you think they already cover a certain subject well enough.
60 |
61 | ## Pay attention to grammar
62 |
63 | Ensure your list is grammatically correct, typo-free and has no Markdown formatting errors. This should also apply to pull requests.
64 |
65 | ## Choose an appropriate license
66 |
67 | Keep in mind that if you [haven't selected a license](http://choosealicense.com/no-license/), it basically means the people are *not* allowed to reproduce, distribute or create derivative works.
68 |
69 | [Creative Commons licenses](https://creativecommons.org/) are perfect for this purpose. **We would recommend [`CC0`](https://creativecommons.org/publicdomain/zero/1.0/).** Code licenses like MIT, BSD, GPL, and so forth are not recommended.
70 |
71 | ## Include contribution guidelines
72 |
73 | People who are contributing to your list should have a clear understanding of how they should do so.
74 |
75 | If you don't feel like writing one from scratch, feel free to take our [contributing.md](contributing.md) and modify it to your own needs.
76 |
77 | ## Stylize your list properly
78 |
79 | Create a [table of contents](https://github.com/sindresorhus/stuff/blob/master/toc-generators.md), organize the content into different categories, and use images if suitable. Ensure all entries are consistent (e.g. all entry descriptions end in a `.`).
80 |
81 | ## Accept other people's opinion
82 |
83 | If you're an owner of the list, respect other people's opinion. If there are plenty of users not agreeing to your decision, give it a second thought.
84 |
--------------------------------------------------------------------------------
/media/mentioned-badge-flat.svg:
--------------------------------------------------------------------------------
1 | Mentioned in an Awesome list
2 |
--------------------------------------------------------------------------------
/media/badge.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/pull_request_template.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | **[Insert URL to the list here]**
8 |
9 | **[Explain what this list is about and why it should be included here]**
10 |
11 |
12 | ### By submitting this pull request I confirm I've read and complied with the below requirements 🖖
13 |
14 | **Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.**
15 |
16 | ## Requirements for your pull request
17 |
18 | - **Don't waste my time.** Do a good job, adhere to all the guidelines, and be responsive.
19 | - **You have to review at least 2 other [open pull requests](https://github.com/sindresorhus/awesome/pulls?q=is%3Apr+is%3Aopen).**
20 | Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration.
21 | - You have read and understood the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
22 | - This pull request has a title in the format `Add Name of List`.
23 | - ✅ `Add Swift`
24 | - ✅ `Add Software Architecture`
25 | - ❌ `Update readme.md`
26 | - ❌ `Add Awesome Swift`
27 | - ❌ `Add swift`
28 | - ❌ `Adding Swift`
29 | - ❌ `Added Swift`
30 | - Your entry here should include a short description about the project/theme of the list. **It should not describe the list itself.** The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
31 | - ✅ `- [iOS](…) - Mobile operating system for Apple phones and tablets.`
32 | - ✅ `- [Framer](…) - Prototyping interactive UI designs.`
33 | - ❌ `- [iOS](…) - Resources and tools for iOS development.`
34 | - ❌ `- [Framer](…)`
35 | - ❌ `- [Framer](…) - prototyping interactive UI designs`
36 | - Your entry should be added at the bottom of the appropriate category.
37 | - The suggested Awesome list complies with the below requirements.
38 |
39 |
40 | ## Requirements for your Awesome list
41 |
42 | - **Has been around for at least 30 days.** That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
43 | - Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
44 | - **Includes a succinct description of the project/theme at the top of the readme.** [(Example)](https://github.com/willempienaar/awesome-quantified-self)
45 | - ✅ `Mobile operating system for Apple phones and tablets.`
46 | - ✅ `Prototyping interactive UI designs.`
47 | - ❌ `Resources and tools for iOS development.`
48 | - ❌ `Awesome Framer packages and tools.`
49 | - It's the result of hard work and the best I could possibly produce.
50 | **If you have not put in considerable effort into your list, your pull request will be immediately closed.**
51 | - The heading title of your list should be in the following format: `# Awesome Name of List`
52 | - ✅ `# Awesome Swift`
53 | - ✅ `# Awesome Web Typography`
54 | - ❌ `# awesome-swift`
55 | - ❌ `# `
56 | - Non-generated Markdown file in a GitHub repo.
57 | - The repo should have `awesome-list` & `awesome` as [GitHub topics](https://help.github.com/articles/about-topics). I encourage you to add more relevant topics.
58 | - Not a duplicate. Please search for existing submissions.
59 | - Only has awesome items. Awesome lists are curations of the best, not everything.
60 | - Includes a project logo/illustration whenever possible.
61 | - Either centered, fullwidth, or placed at the top-right of the readme. [(Example)](https://github.com/sindresorhus/awesome-electron)
62 | - The image should link to the project website or any relevant website.
63 | - **The image should be high-DPI.** Set it to maximum half the width of the original image.
64 | - Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
65 | - Includes the [Awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge).
66 | - Should be placed on the right side of the readme heading.
67 | - Can be placed centered if the list has a centered graphics header.
68 | - Should link back to this list.
69 | - Has a Table of Contents section.
70 | - Should be named `Contents`, not `Table of Contents`.
71 | - Should be the first section in the list.
72 | - Should only have one level of [nested lists](https://commonmark.org/help/tutorial/10-nestedLists.html), preferably none.
73 | - Has an [appropriate license](https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license).
74 | - That means something like CC0, **not a code licence like MIT, BSD, Apache, etc.**
75 | - [WTFPL](http://www.wtfpl.net) and [Unlicense](http://unlicense.org) are not acceptable licenses.
76 | - **If you use a license badge, it should be SVG, not PNG.**
77 | - To verify that you've read all the guidelines, please add comment with just the word `unicorn`.
78 | - Has [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/awesome.md#include-contribution-guidelines).
79 | - The file should be named `contributing.md`. Casing is up to you.
80 | - Has consistent formatting and proper spelling/grammar.
81 | - The link and description are separated by a dash. Example: `- [AVA](…) - JavaScript test runner.`
82 | - The description starts with an uppercase character and ends with a period.
83 | - Consistent and correct naming. For example, `Node.js`, not `NodeJS` or `node.js`.
84 | - Doesn't include a Travis badge. You can still use Travis for list linting, but the badge has no value in the readme.
85 | - Doesn't include an `Inspired by awesome-foo` or `Inspired by the Awesome project` kinda link at the top of the readme. The Awesome badge is enough.
86 |
87 | **Go to the top and read it again.**
88 |
--------------------------------------------------------------------------------
/media/mentioned-badge.svg:
--------------------------------------------------------------------------------
1 | Mentioned in an Awesome list
2 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 |