Skip to content

Commit 9ce5e16

Browse files
author
Oliver Cervera
authored
Update README.md
More updates.
1 parent dde2691 commit 9ce5e16

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,28 @@ It is highly customizable to user needs.
77

88
It has been tested with Debian 10 and OpenMediaVault 5.
99

10-
Contributions are welcome.
10+
Contributions are welcome: there's always room for improvement!
11+
12+
This readme has some rough edges which will be smoothened over time.
1113

1214
# Features
1315
[WIP]
1416

1517
# Requirements
16-
- Markdown to have a nicely formatted email - `apt install python-markdown`
18+
- Markdown to have nice emails
1719
- Hd-Idle to spin down disks - [Link TBD]
1820

1921
# Installation
2022
[WIP]
23+
1. Install markdown `apt install python-markdown`
24+
2. Place the script wherever you prefer e.g. /usr/sbin/snapraid
25+
3. Give executable rights to root user
26+
3. Open the script and add your email address at line 74 - more configs below
27+
4. Tweak the script as required
28+
5. Schedule the script execution time
2129

2230
# Known Issues
23-
Hard disk spin down does not work. The script probably does not handle this correctly while running.
31+
Hard disk spin down does not work: they are immediately woken up. The script probably does not handle this correctly while running.
2432

2533
# Credits
2634
All rights belong to the respective creators.

0 commit comments

Comments
 (0)