-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
start with init work #1
Merged
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
61b2a92
add lint actions and readme structure
Delta456 3c1c8bf
fix proper action path and readme stuff
Delta456 61804e0
try another lint
Delta456 39082cf
chore: follow awesome spec
Delta456 6f22cff
chore: follow awesome spec x2
Delta456 6dae513
README: add lint rules
Delta456 d2a20d6
README: modify lint rules
Delta456 32e5b64
README: exp with lint rules
Delta456 a44908a
README: finish up with lint
Delta456 f4d6b66
README: fix lint rules
Delta456 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 | ||
<!-- TODO: remove awesome-git-repo-age when repo is older than 30 days --> | ||
<!--lint ignore double-link awesome-git-repo-age awesome-github --> | ||
|
||
# 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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not too fond of these hacks, but it is needed to pass the CI and will be removed upon further investigation.