-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
π docs: write setup docs in readme
- Loading branch information
1 parent
462cbe8
commit c4cc262
Showing
1 changed file
with
37 additions
and
4 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 |
---|---|---|
@@ -1,5 +1,38 @@ | ||
# Changing plymouth theme on linux | ||
# Plymouth Theme Changer for Linux | ||
This script has been made due to personal needs whilst customizing `GNU/Linux` distro which I use. | ||
|
||
## Installation process | ||
- Download the file and run setup.sh | ||
- Run plymouth-theme to change plymouth theme! | ||
- [Plymouth Theme Changer for Linux](#plymouth-theme-changer-for-linux) | ||
- [Setup](#setup) | ||
- [Troubleshooting](#troubleshooting) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
# Setup | ||
1. clone the git repository | ||
```bash | ||
git clone https://github.com/kylesinlynn/change-plymouth-theme-bash.git | ||
``` | ||
|
||
2. move into the cloned directory | ||
```bash | ||
cd change-plymouth-theme-bash | ||
``` | ||
|
||
3. run the setup script `setup.sh` | ||
```bash | ||
bash setup.sh | ||
``` | ||
|
||
4. try using the command `plymouth-theme` | ||
```bash | ||
plymouth-theme | ||
``` | ||
|
||
# Troubleshooting | ||
Create an issue upon your error that is associated with this project. | ||
|
||
# Contributing | ||
Feel free to fork and create pull requests. Your contribution will be appreciated. | ||
|
||
# License | ||
This project is licensed under [BSD License](LICENSE). |