Skip to content

Commit fa87fd0

Browse files
authored
Added install instructions.
1 parent 261b16c commit fa87fd0

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Chimer is a pure Rust cli timer & stopwatch application.
44
**Chimer was made as a way of practicing Rust I am in no way experienced in Rust.**
55
**Thus this program is probably painful to look at.**
66

7-
Help message:
7+
## Help message:
88
```
99
Chimer is a pure Rust cli timer & stopwatch application.
1010
----------------------------------------------------------------------------------------------------------
@@ -17,3 +17,5 @@ Usage:
1717
1818
```
1919

20+
## How to install:
21+
Clone the repo and build it using cargo then copy the executable and `alarmSound.mp3` to a new directory in my case:`/bin/chimerBin`. Create a symbolic link to the executable in /bin/ outside of the program folder. Make sure the program files folder has writing and reading enabled most likely using `chmod`. Using chimer requires this the exe will panic if this is not done no exception handeling has been implemented for permision related exceptions. If you do get an exception then please remove the `timer.yaml` file that might have been created and start a new timer as a test.

0 commit comments

Comments
 (0)