Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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/
#.idea/

# nano tmp files
.*.swp
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <SECRET>

Options:
--mount <MOUNT>
--secret <SECRET>
--name <NAME>
--calendar <CALENDAR>
--root-event <ROOT_EVENT>
-h, --help Print help
```



## Contributions

Contributions are more than welcome.
Expand Down
5 changes: 5 additions & 0 deletions dockerCompile.sh
Original file line number Diff line number Diff line change
@@ -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