Skip to content

Commit 8646334

Browse files
committed
Add notice encouraging users to use tinty over profile_helper
1 parent f37f7e8 commit 8646334

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ look at the [Tinted Theming] Home repository.
1414

1515
![Shell image]
1616

17+
Note: tinted-shell currently has 2 functions:
18+
19+
1. It contains shell script themes in `scripts/*.sh` which one can use
20+
to set their shell color theme.
21+
2. There is a "profile_helper" which is used to manage the settings of
22+
themes throughout the system. This manager can be hooked up to all
23+
other tinted templates and changing a theme in tinted-shell will
24+
change all themes throughout the system.
25+
26+
If you are using tinted-shell for point number 2, we suggest using
27+
[Tinty] as your theme manager instead, which uses tinted-shell
28+
`scripts/*.sh` themesunder the hood by default. More information under
29+
[Theme Managers](#theme-managers).
30+
1731
## Use Cases for using a script to theme your shell
1832

1933
- Portability Across Different Terminal Emulators and SSH sessions.
@@ -25,7 +39,7 @@ look at the [Tinted Theming] Home repository.
2539
Clone the repo locally and execute the script with your posix compliant
2640
shell (sh, bash, zsh, etc).
2741

28-
```shell
42+
```sh
2943
cd path/to/cloned/repo/tinted-shell
3044
sh ./scripts/base16-mocha.sh
3145
```

0 commit comments

Comments
 (0)