mirror of
https://github.com/alacritty/alacritty-theme
synced 2024-11-16 19:51:03 +01:00
Update README.md
This updates the readme to bring it more in line with other Alacritty projects and fix references to the old project location.
This commit is contained in:
parent
343d033b00
commit
170a8e768a
5 changed files with 48 additions and 75 deletions
17
.github/ISSUE_TEMPLATE.md
vendored
17
.github/ISSUE_TEMPLATE.md
vendored
|
@ -1,17 +0,0 @@
|
||||||
**Describe the bug**
|
|
||||||
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
|
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Environment (please complete the following information):**
|
|
||||||
|
|
||||||
- OS: [e.g. iOS]
|
|
||||||
- Terminal Emulator [e.g. gnome-terminal, iterm]
|
|
||||||
- Shell [e.g. bash, zsh]
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
|
|
||||||
Add any other context about the problem here.
|
|
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,15 +0,0 @@
|
||||||
* **The PR fulfills following requirements**
|
|
||||||
- [ ] Placed theme file in `themes` directory
|
|
||||||
- [ ] Placed screenshot file in `images` directory [use [print_colors](https://raw.githubusercontent.com/eendroroy/bin_scripts/master/public/print_colors) script to take screenshot]
|
|
||||||
- [ ] Updated `schemes.yaml` file
|
|
||||||
- [ ] Added entry in `README.md` under "Color Schemes" section in alphabetical order
|
|
||||||
|
|
||||||
* **Link to the source repository**
|
|
||||||
|
|
||||||
Please mention the source of the color scheme (preferably link to the original repo)
|
|
||||||
|
|
||||||
* **Modifications**
|
|
||||||
|
|
||||||
- [ ] Copied from source without modification
|
|
||||||
- [ ] Minor modifications (changed few colors for clear visibility)
|
|
||||||
- [ ] Heavily modified (almost all the colors are modified)
|
|
3
LICENSE
3
LICENSE
|
@ -186,7 +186,8 @@ APPENDIX: How to apply the Apache License to your work.
|
||||||
same "printed page" as the copyright notice for easier
|
same "printed page" as the copyright notice for easier
|
||||||
identification within third-party archives.
|
identification within third-party archives.
|
||||||
|
|
||||||
Copyright 2019-2020 indrajit
|
Copyright 2019-2023 indrajit
|
||||||
|
Copyright 2023- The Alacritty Project
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
|
|
78
README.md
78
README.md
|
@ -1,37 +1,35 @@
|
||||||
# Alacritty Theme
|
# Alacritty Theme
|
||||||
|
|
||||||
[![license](https://img.shields.io/github/license/eendroroy/alacritty-theme.svg)](https://github.com/eendroroy/alacritty-theme/blob/master/LICENSE)
|
Collection of colorschemes for easy configuration of the [Alacritty terminal
|
||||||
[![GitHub tag](https://img.shields.io/github/tag/eendroroy/alacritty-theme.svg)](https://github.com/eendroroy/alacritty-theme/tags)
|
emulator].
|
||||||
[![GitHub last commit (branch)](https://img.shields.io/github/last-commit/eendroroy/alacritty-theme/master.svg)](https://github.com/eendroroy/alacritty-theme)
|
|
||||||
|
|
||||||
[![GitHub issues](https://img.shields.io/github/issues/eendroroy/alacritty-theme.svg)](https://github.com/eendroroy/alacritty-theme/issues)
|
[Alacritty terminal emulator]: https://github.com/alacritty/alacritty
|
||||||
[![GitHub closed issues](https://img.shields.io/github/issues-closed/eendroroy/alacritty-theme.svg)](https://github.com/eendroroy/alacritty-theme/issues?q=is%3Aissue+is%3Aclosed)
|
|
||||||
[![GitHub pull requests](https://img.shields.io/github/issues-pr/eendroroy/alacritty-theme.svg)](https://github.com/eendroroy/alacritty-theme/pulls)
|
|
||||||
[![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/eendroroy/alacritty-theme.svg)](https://github.com/eendroroy/alacritty-theme/pulls?q=is%3Apr+is%3Aclosed)
|
|
||||||
|
|
||||||
This repo lists (copied or slightly modified) color schemes for `alacritty`
|
## Installation
|
||||||
|
|
||||||
- collected from various sources
|
### Imports
|
||||||
- converted from other terminal emulator themes
|
|
||||||
- created from vim or emacs color schemes.
|
|
||||||
|
|
||||||
## How to apply?
|
Clone the repository, or download the theme of your choice:
|
||||||
|
|
||||||
There are multiple ways -
|
```sh
|
||||||
|
# We use Alacritty's default Linux config directory as our storage location here.
|
||||||
|
mkdir -p ~/.config/alacritty/themes
|
||||||
|
git clone https://github.com/alacritty/alacritty-theme ~/.config/alacritty/themes
|
||||||
|
```
|
||||||
|
|
||||||
1. Import the scheme in `alacritty.yaml` file:
|
Add an import to your `alacritty.yml` (Replace `{theme}` with your desired
|
||||||
|
colorscheme):
|
||||||
|
|
||||||
Clone the repository:
|
```yaml
|
||||||
|
import:
|
||||||
|
- ~/.config/alacritty/themes/themes/{theme}.yaml
|
||||||
|
```
|
||||||
|
|
||||||
`git clone https://github.com/eendroroy/alacritty-theme.git ~/.alacritty-colorscheme`
|
### Manual
|
||||||
|
|
||||||
And add the below line into `alacritty.yaml`:
|
To manually include a colorscheme in an existing `alacritty.yml`, you just need
|
||||||
```yaml
|
to copy the entire content of the theme into the root level of your
|
||||||
import:
|
configuration file.
|
||||||
- ~/.alacritty-colorscheme/themes/{scheme_name}.yaml
|
|
||||||
```
|
|
||||||
2. Copy the content of `yaml` file in the `colors` section into `~/.config/alacritty/alacritty.yml` file.
|
|
||||||
3. Use [alacritty-colorscheme](https://github.com/toggle-corp/alacritty-colorscheme). Read details here: [Docs](https://github.com/toggle-corp/alacritty-colorscheme/blob/master/README.md)
|
|
||||||
|
|
||||||
## Color Schemes
|
## Color Schemes
|
||||||
|
|
||||||
|
@ -107,27 +105,23 @@ There are multiple ways -
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Bug reports and pull requests are welcome on GitHub at [alacritty-theme](https://github.com/eendroroy/alacritty-theme)
|
Bug reports and pull requests are welcome on GitHub at the [alacritty-theme]
|
||||||
repository. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
|
repository.
|
||||||
adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
||||||
|
|
||||||
1. Fork it ( https://github.com/eendroroy/alacritty-theme/fork )
|
[alacritty-theme]: https://github.com/alacritty/alacritty-theme
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
|
||||||
5. Create a new Pull Request
|
|
||||||
|
|
||||||
Suggestions:
|
|
||||||
|
|
||||||
- Ensure `{theme}.yaml` file in `theme` directory
|
|
||||||
- Ensure theme preview (ie: `{theme}.png`) in `images` directory
|
|
||||||
- Use [print_colors](https://raw.githubusercontent.com/eendroroy/bin_scripts/master/public/print_colors) script to generate preview
|
|
||||||
- Ensure `schemes.yaml` file is updated
|
|
||||||
- Ensure theme listing in `README.md` following alphabetical ordering
|
|
||||||
|
|
||||||
## Author
|
To add a new theme, just create a Pull Request with the following changes:
|
||||||
|
|
||||||
* **indrajit** - *Owner* - [eendroroy](https://github.com/eendroroy)
|
- Add your theme to the `themes` directory with the `{theme}.yaml` file format
|
||||||
|
- Create a screenshot of your theme using the [print_colors script]
|
||||||
|
- Add the screenshot to the `immages` directory with the `{theme}.png` file format
|
||||||
|
- Add your theme to the `schemes.yaml`
|
||||||
|
- Add your theme to the `README.md`, following alphabetical ordering
|
||||||
|
|
||||||
|
## Maintainers
|
||||||
|
|
||||||
|
* **indrajit** - *Author* - [eendroroy](https://github.com/eendroroy)
|
||||||
|
* **Christian Dürr** - *Maintainer* - [chrisduerr](https://github.com/chrisduerr)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
10
print_colors.sh
Executable file
10
print_colors.sh
Executable file
|
@ -0,0 +1,10 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
printf "|039| \033[39mDefault \033[m |049| \033[49mDefault \033[m |037| \033[37mLight gray \033[m |047| \033[47mLight gray \033[m\n"
|
||||||
|
printf "|030| \033[30mBlack \033[m |040| \033[40mBlack \033[m |090| \033[90mDark gray \033[m |100| \033[100mDark gray \033[m\n"
|
||||||
|
printf "|031| \033[31mRed \033[m |041| \033[41mRed \033[m |091| \033[91mLight red \033[m |101| \033[101mLight red \033[m\n"
|
||||||
|
printf "|032| \033[32mGreen \033[m |042| \033[42mGreen \033[m |092| \033[92mLight green \033[m |102| \033[102mLight green \033[m\n"
|
||||||
|
printf "|033| \033[33mYellow \033[m |043| \033[43mYellow \033[m |093| \033[93mLight yellow \033[m |103| \033[103mLight yellow \033[m\n"
|
||||||
|
printf "|034| \033[34mBlue \033[m |044| \033[44mBlue \033[m |094| \033[94mLight blue \033[m |104| \033[104mLight blue \033[m\n"
|
||||||
|
printf "|035| \033[35mMagenta \033[m |045| \033[45mMagenta \033[m |095| \033[95mLight magenta \033[m |105| \033[105mLight magenta \033[m\n"
|
||||||
|
printf "|036| \033[36mCyan \033[m |046| \033[46mCyan \033[m |096| \033[96mLight cyan \033[m |106| \033[106mLight cyan \033[m\n"
|
Loading…
Reference in a new issue