Skip to content

Commit de375d8

Browse files
authored
feat: add a README and move LICENSE file to the root (OpenSource-Communities#207)
* chores: move LICENSE.txt to the root * feat: add README to the root * fix: capitalization * fix: create list in Contributing section to make space for forked repos' contributing guidelines
1 parent a38065a commit de375d8

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed
File renamed without changes.

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<div align="center">
2+
  <br>
3+
  <img alt="OpenSauced" src="https://github.com/open-sauced/assets/blob/main/logos/logo-on-dark.png">
4+
  <h1>🍕 The Open Source Education Path with OpenSauced 🍕</h1>
5+
  <strong>Welcome to OpenSauced's Intro Repository!</strong>
6+
</div>
7+
8+
<br>
9+
10+
This repository is the home of OpenSauced courses for people who want to learn to contribute to open source projects and for people who want to become project maintainers.
11+
12+
Head over to The Open Source Education Path with OpenSauced on [GitHub](./docs/README.md) or [the website](https://intro.opensauced.pizza/#/README) to start learning!
13+
14+
## **🤝 Contributing**
15+
16+
We encourage you to contribute to OpenSauced! All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md).
17+
18+
- For information on how to contribute to the intro repository, check out the [Contributing Guidelines](./docs/CONTRIBUTING.md).
19+
20+
- To translate our Intro to Open Source or Becoming a Maintainer course, check out our [🌐 i18n Guidelines](./docs/i18n-guidelines.md).
21+
22+
## **🍕 Community**
23+
24+
Do you have questions or need help? Join our community [Discord](https://discord.gg/U2peSNf23P).
25+
26+
## **⚖️ LICENSE**
27+
28+
[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/88x31.png)](https://creativecommons.org/licenses/by/4.0/)

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</div>
99

1010

11-
**Welcome to the Open Source Education Path with OpenSauced!**
11+
**Welcome to The Open Source Education Path with OpenSauced!**
1212

1313
Open source projects offer potential for personal growth, networking and collaboration, and meaningful community contributions. Because of this, there is a growing interest in open source and a need for resources to help people get started.
1414

0 commit comments

Comments
 (0)