Skip to content

Commit

Permalink
minor copyedits to CLI instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jnny committed Jul 31, 2024
1 parent a9aecff commit 8357855
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The command line version of Ouisync.

## Instalation
## Installation

Ouisync can be build from source or installed as a docker container.

Expand All @@ -13,7 +13,7 @@ Ouisync can be build from source or installed as a docker container.
`sudo apt install pkg-config libfuse-dev`

2. Install Rust using instructions from [rust-lang.org](https://www.rust-lang.org/tools/install).
3. Build the app:
3. `cd path/to/ouisync' and build the app with:

`cargo build --release --bin ouisync`

Expand All @@ -27,7 +27,7 @@ The Ouisync CLI docker image is available on [dockerhub](https://hub.docker.com/

## Usage

Run `ouisync --help` to see the available commands. Use `ouisync COMMAND --help` to see detailed
Run `./ouisync --help` to see the available commands. Use `./ouisync COMMAND --help` to see detailed
help for the given command. This document contains brief explanation of the most common commands.

NOTE: All settings are persisted across restarts.
Expand All @@ -38,7 +38,7 @@ NOTE: All settings are persisted across restarts.

Run

ouisync start
./ouisync start

Which runs Ouisync it in the foreground. To run in the background use e.g. systemd or similar.

Expand Down

0 comments on commit 8357855

Please sign in to comment.