Skip to content

Commit c4cc262

Browse files
committed
📃 docs: write setup docs in readme
1 parent 462cbe8 commit c4cc262

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

‎README.md

+37-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
1-
# Changing plymouth theme on linux
1+
# Plymouth Theme Changer for Linux
2+
This script has been made due to personal needs whilst customizing `GNU/Linux` distro which I use.
23

3-
## Installation process
4-
- Download the file and run setup.sh
5-
- Run plymouth-theme to change plymouth theme!
4+
- [Plymouth Theme Changer for Linux](#plymouth-theme-changer-for-linux)
5+
- [Setup](#setup)
6+
- [Troubleshooting](#troubleshooting)
7+
- [Contributing](#contributing)
8+
- [License](#license)
9+
10+
# Setup
11+
1. clone the git repository
12+
```bash
13+
git clone https://github.com/kylesinlynn/change-plymouth-theme-bash.git
14+
```
15+
16+
2. move into the cloned directory
17+
```bash
18+
cd change-plymouth-theme-bash
19+
```
20+
21+
3. run the setup script `setup.sh`
22+
```bash
23+
bash setup.sh
24+
```
25+
26+
4. try using the command `plymouth-theme`
27+
```bash
28+
plymouth-theme
29+
```
30+
31+
# Troubleshooting
32+
Create an issue upon your error that is associated with this project.
33+
34+
# Contributing
35+
Feel free to fork and create pull requests. Your contribution will be appreciated.
36+
37+
# License
38+
This project is licensed under [BSD License](LICENSE).

0 commit comments

Comments
 (0)