Skip to content

Commit

Permalink
Added install instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
80sVectorz authored Jun 18, 2022
1 parent 261b16c commit fa87fd0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Chimer is a pure Rust cli timer & stopwatch application.
**Chimer was made as a way of practicing Rust I am in no way experienced in Rust.**
**Thus this program is probably painful to look at.**

Help message:
## Help message:
```
Chimer is a pure Rust cli timer & stopwatch application.
----------------------------------------------------------------------------------------------------------
Expand All @@ -17,3 +17,5 @@ Usage:
```

## How to install:
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 comments on commit fa87fd0

Please sign in to comment.