-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
73 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: Lint | ||
on: | ||
push: | ||
branches: [master] | ||
pull_request: | ||
types: [opened, synchronize] | ||
jobs: | ||
test: | ||
name: Run awesome linter | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v1 | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: 16 | ||
- run: npx awesome-lint README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Contributing | ||
|
||
## What is a "Complete" Project | ||
|
||
A project is considered complete when: | ||
|
||
1. It implements the minimum viable product for the idea | ||
2. It includes a `README` with screenshots or a GIF describing the | ||
application's behavior. See [Freeze][freeze] or [VHS][vhs] for easy demos. | ||
|
||
> [!NOTE] | ||
> Please include an overview of what Charm libraries you used to build your project. | ||
## Feedback | ||
|
||
We'd love to hear your thoughts on this project. Join the chatter happening on [Discord](https://charm.sh/chat). | ||
|
||
[freeze]: https://github.com/charmbracelet/freeze | ||
[vhs]: https://github.com/charmbracelet/vhs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Charm Community | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,29 @@ | ||
# Strutt your stuff | ||
<!--lint ignore double-link awesome-git-repo-age awesome-github --> | ||
<!-- TODO: remove awesome-git-repo-age when repo is older than 30 days --> | ||
|
||
# Awesome Charm [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) | ||
|
||
This is your one-stop shop to find *incredible* community projects built with | ||
the [Charm][charm] stack. Get inspired, and most importantly, get building! | ||
the [Charm](https://github.com/charmbracelet/) stack. Get inspired, and most importantly, get building! | ||
|
||
This is an entirely community-driven repo for members of the community to share | ||
their projects. You can PR your completed projects to be included in the list. | ||
|
||
You're also welcome to contribute ideas without building them out. | ||
|
||
## What is a "Complete" Project | ||
|
||
A project is considered complete when: | ||
1. It implements the minimum viable product for the idea | ||
2. It includes a `README` with screenshots or a GIF describing the | ||
application's behavior. See [Freeze][freeze] or [VHS][vhs] for easy demos. | ||
|
||
> [!NOTE] | ||
> Please include an overview of what Charm libraries you used to build your project. | ||
## Feedback | ||
their projects. You can PR your completed projects to be included in the list. | ||
|
||
We’d love to hear your thoughts on this project. Join the chatter happening on [Discord](https://charm.sh/chat). | ||
You're also welcome to contribute ideas without building them out. | ||
|
||
## License | ||
To contribute, see [CONTRIBUTING.md](./CONTRIBUTING.md) | ||
|
||
[MIT](https://github.com/charmbracelet/skate/raw/main/LICENSE) | ||
## Contents | ||
|
||
*** | ||
- [Applications](#applications) | ||
- [Bubbletea](#bubbletea) | ||
- [Other](#other) | ||
- [Editor Plugins](#editor-plugins) | ||
|
||
Part of [Charm](https://charm.sh). | ||
## Applications | ||
|
||
<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a> | ||
### Bubbletea | ||
|
||
Charm热爱开源 • Charm loves open source | ||
## Other | ||
|
||
[charm]: https://github.com/charmbracelet/ | ||
[freeze]: https://github.com/charmbracelet/freeze | ||
[vhs]: https://github.com/charmbracelet/vhs | ||
### Editor Plugins |