diff --git a/.gitignore b/.gitignore index d01bd1a..a988b95 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,7 @@ Cargo.lock # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ \ No newline at end of file +#.idea/ + +# nano tmp files +.*.swp diff --git a/README.md b/README.md index ad3e87f..a05802d 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,36 @@ The diagram above took too long to create, so I no longer have the energy to wri On a more serious note: Google Calendar is a wonderful service. I'd highly discourage anyone from using this for anything other than educational purposes. Abusing a free service is wrong—don't be evil. +## Usage +### Compiling in Docker + +If you have docker installed, you can compile with the following command: + +```sh +docker run -v `pwd`:/app --workdir="/app" --rm -it rust:1.80 bash -c "apt-get update && apt-get install -y libfuse3-dev && cargo build" +``` + +When it completes, you will have the binary available at: `target/debug/when-fs` + +### Setting Up + +Confirm the binary compiled correctly by running `target/debug/when-fs --help`. You should see output like this: + +```sh +$ target/debug/when-fs --help +Usage: when-fs [OPTIONS] --secret + +Options: + --mount + --secret + --name + --calendar + --root-event + -h, --help Print help +``` + + + ## Contributions Contributions are more than welcome. diff --git a/dockerCompile.sh b/dockerCompile.sh new file mode 100755 index 0000000..a1582c9 --- /dev/null +++ b/dockerCompile.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +docker run -v `pwd`:/app --workdir="/app" -it rust bash -c "apt-get update && apt-get install -y libfuse3-dev && cargo build" + +# compiles file to target/debug/when-fs