Skip to content

Commit

Permalink
Flesh out README a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
r-ash committed Dec 4, 2023
1 parent 17f23f8 commit 490664d
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@

An [`orderly1`](https://github.com/vimc/orderly1) remote hosted on a shared drive. Either a network share or a synced onedrive.

### Usage
## Installation

```
remotes::install_github("vimc/orderly.sharedrive")
```

## Usage

Configure your `orderly_config.yml` as, for example:

Expand All @@ -22,7 +28,7 @@ remote:

Where

* `path` is the path to your shared drive. This can be an environment variable
* `path` is the path to your shared drive. We recommend you use an environment variable stored in `orderly_envir.yml` if you are working with other people

`orderly.sharedrive` will store files as `archive/<name>/<id>` where `<name>` is the report name and `<id>` is a zip archive of the report contents. These must be treated as read-only and must not be modified (they do not have a file extension to help this).

Expand Down

0 comments on commit 490664d

Please sign in to comment.