Fully documented!
This commit is contained in:
parent
2ba4061454
commit
71f922de59
@ -11,7 +11,7 @@ Clone the repo with submodules
|
|||||||
```
|
```
|
||||||
git clone --recurse-submodules https://git.sys42.net/dakedres/shchemes.git
|
git clone --recurse-submodules https://git.sys42.net/dakedres/shchemes.git
|
||||||
```
|
```
|
||||||
Add symlink it to somewhere in your PATH. Pick your poison
|
Symlink to it somewhere in your PATH. Pick your poison
|
||||||
```sh
|
```sh
|
||||||
ln -s $PWD/shchemes ~/bin/shchemes
|
ln -s $PWD/shchemes ~/bin/shchemes
|
||||||
ln -s $PWD/shchemes ~/.local/bin/shchemes
|
ln -s $PWD/shchemes ~/.local/bin/shchemes
|
||||||
@ -55,6 +55,8 @@ Note you'll have to add all the comments for where to place the injections
|
|||||||
|
|
||||||
See the [cookbook](./doc/cookbook.md) for some ideas on ways to use Shchemes.
|
See the [cookbook](./doc/cookbook.md) for some ideas on ways to use Shchemes.
|
||||||
|
|
||||||
|
You can read the manual [in your browser](./doc/manual.md) or by running `shchemes help`.
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
This software is a work of opportunism
|
This software is a work of opportunism
|
||||||
|
|
||||||
|
@ -50,7 +50,7 @@ shchemes create_theme alacritty --format=base24
|
|||||||
|
|
||||||
## METHODS
|
## METHODS
|
||||||
|
|
||||||
## create_theme
|
## create_theme {#create_theme}
|
||||||
|
|
||||||
Apply the color scheme to the template for a given app
|
Apply the color scheme to the template for a given app
|
||||||
```
|
```
|
||||||
@ -66,7 +66,9 @@ In the given file, looks for a comment that indicates a Shchemes injection block
|
|||||||
shchemes inject PATH
|
shchemes inject PATH
|
||||||
```
|
```
|
||||||
|
|
||||||
## install_tinted_scheme
|
See also: [`create_theme`](#create_theme)
|
||||||
|
|
||||||
|
## install_tinted_scheme {#install_tinted_scheme}
|
||||||
Installs a color scheme from the [tinted-theming/schemes](https://github.com/tinted-theming/schemes).
|
Installs a color scheme from the [tinted-theming/schemes](https://github.com/tinted-theming/schemes).
|
||||||
|
|
||||||
You can find a gallery of the base16 themes here:
|
You can find a gallery of the base16 themes here:
|
||||||
@ -75,7 +77,40 @@ You can find a gallery of the base16 themes here:
|
|||||||
shchemes install_tinted_scheme
|
shchemes install_tinted_scheme
|
||||||
```
|
```
|
||||||
|
|
||||||
See also: [`SCHEME`](#SCHEME) [`--scheme`](#scheme)
|
See also: [`SCHEME`](#SCHEME) [`--scheme`](#scheme) [`convert_tinted_scheme`](#convert_tinted_scheme)
|
||||||
|
|
||||||
|
## convert_tinted_scheme {#convert_tinted_scheme}
|
||||||
|
Converts a tinted-theming scheme to a .properties format for use in shchemes.
|
||||||
|
|
||||||
|
```
|
||||||
|
shchemes convert_tinted_scheme pico.yaml
|
||||||
|
cat pico.yaml > shchemes convert_tinted_scheme
|
||||||
|
```
|
||||||
|
|
||||||
|
See also: [`install_tinted_scheme`](#install_tinted_scheme)
|
||||||
|
|
||||||
|
## install_tinted_template {#install_tinted_template}
|
||||||
|
Downloads, converts, and installs a tinted-theming template from a given url.
|
||||||
|
|
||||||
|
```
|
||||||
|
shchemes install_tinted_template https://raw.githubusercontent.com/tinted-theming/base16-emacs/main/templates/default.mustache
|
||||||
|
```
|
||||||
|
|
||||||
|
It is recommended that you use already-maintained shchemes templates rather than just installing and converting third party ones.
|
||||||
|
|
||||||
|
See also: [`convert_tinted_template`](#convert_tinted_template)
|
||||||
|
|
||||||
|
## convert_tinted_template {#convert_tinted_template}
|
||||||
|
Converts a tinted-theming .mustache template to a shchemes template.
|
||||||
|
|
||||||
|
```
|
||||||
|
shchemes convert_tinted_template default.mustache > ~/shchemes/base16/templates/emacs.mustache
|
||||||
|
```
|
||||||
|
|
||||||
|
See also: [`install_tinted_template`](#install_tinted_template)
|
||||||
|
|
||||||
|
## manual, man, help
|
||||||
|
Opens this manual
|
||||||
|
|
||||||
# AUTHOR
|
# AUTHOR
|
||||||
|
|
||||||
|
@ -75,6 +75,8 @@ pipes the stdout into the content of the injection block.
|
|||||||
shchemes inject PATH
|
shchemes inject PATH
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
See also: \f[V]create_theme\f[R]
|
||||||
.SS install_tinted_scheme
|
.SS install_tinted_scheme
|
||||||
.PP
|
.PP
|
||||||
Installs a color scheme from the
|
Installs a color scheme from the
|
||||||
@ -90,6 +92,49 @@ shchemes install_tinted_scheme
|
|||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
See also: \f[V]SCHEME\f[R] \f[V]--scheme\f[R]
|
See also: \f[V]SCHEME\f[R] \f[V]--scheme\f[R]
|
||||||
|
\f[V]convert_tinted_scheme\f[R]
|
||||||
|
.SS convert_tinted_scheme
|
||||||
|
.PP
|
||||||
|
Converts a tinted-theming scheme to a .properties format for use in
|
||||||
|
shchemes.
|
||||||
|
.IP
|
||||||
|
.nf
|
||||||
|
\f[C]
|
||||||
|
shchemes convert_tinted_scheme pico.yaml
|
||||||
|
cat pico.yaml > shchemes convert_tinted_scheme
|
||||||
|
\f[R]
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
See also: \f[V]install_tinted_scheme\f[R]
|
||||||
|
.SS install_tinted_template
|
||||||
|
.PP
|
||||||
|
Downloads, converts, and installs a tinted-theming template from a given
|
||||||
|
url.
|
||||||
|
.IP
|
||||||
|
.nf
|
||||||
|
\f[C]
|
||||||
|
shchemes install_tinted_template https://raw.githubusercontent.com/tinted-theming/base16-emacs/main/templates/default.mustache
|
||||||
|
\f[R]
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
It is recommended that you use already-maintained shchemes templates
|
||||||
|
rather than just installing and converting third party ones.
|
||||||
|
.PP
|
||||||
|
See also: \f[V]convert_tinted_template\f[R]
|
||||||
|
.SS convert_tinted_template
|
||||||
|
.PP
|
||||||
|
Converts a tinted-theming .mustache template to a shchemes template.
|
||||||
|
.IP
|
||||||
|
.nf
|
||||||
|
\f[C]
|
||||||
|
shchemes convert_tinted_template default.mustache > \[ti]/shchemes/base16/templates/emacs.mustache
|
||||||
|
\f[R]
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
See also: \f[V]install_tinted_template\f[R]
|
||||||
|
.SS manual, man, help
|
||||||
|
.PP
|
||||||
|
Opens this manual
|
||||||
.SH AUTHOR
|
.SH AUTHOR
|
||||||
.PP
|
.PP
|
||||||
Shchemes is written by Dakedres
|
Shchemes is written by Dakedres
|
||||||
|
2
shchemes
2
shchemes
@ -175,7 +175,7 @@ convert_tinted_template() {
|
|||||||
-e 's/\{\{base([0-9A-F]+)-hex\}\}/{{base\1}}/' \
|
-e 's/\{\{base([0-9A-F]+)-hex\}\}/{{base\1}}/' \
|
||||||
-e 's/\{\{base([0-9A-F]+)-rgb-r\}\}/{{rgb_r base\1}}/' \
|
-e 's/\{\{base([0-9A-F]+)-rgb-r\}\}/{{rgb_r base\1}}/' \
|
||||||
-e 's/\{\{base([0-9A-F]+)-rgb-g\}\}/{{rgb_g base\1}}/' \
|
-e 's/\{\{base([0-9A-F]+)-rgb-g\}\}/{{rgb_g base\1}}/' \
|
||||||
-e 's/\{\{base([0-9A-F]+)-rgb-b\}\}/{{rgb_b base\1}}/'
|
-e 's/\{\{base([0-9A-F]+)-rgb-b\}\}/{{rgb_b base\1}}/' "$path"
|
||||||
}
|
}
|
||||||
|
|
||||||
convert_tinted_scheme() {
|
convert_tinted_scheme() {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user