From fa87fd094ef86f558fcae8c961d07f0dd035507f Mon Sep 17 00:00:00 2001 From: 80sVectorz <66908776+krijnlol@users.noreply.github.com> Date: Sat, 18 Jun 2022 08:02:56 +0200 Subject: [PATCH] Added install instructions. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 10fbc5a..c0f8a04 100644 --- a/README.md +++ b/README.md @@ -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. ---------------------------------------------------------------------------------------------------------- @@ -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.