Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
radumarias authored May 30, 2024
1 parent b5dbab8 commit 345c327
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,15 +217,17 @@ echo "test" > test.txt
cat test.txt
```

## Getting the sources
## Locally

### Getting the sources

```bash
git clone [email protected]:radumarias/rencfs.git
````

## Dependencies
### Dependencies

### Rust
#### Rust

To build from source, you need to have Rust installed, you can see more details on how to install
it [here](https://www.rust-lang.org/tools/install).
Expand Down Expand Up @@ -261,19 +263,19 @@ Ubuntu
sudo apt-get update && sudo apt-get install fuse3 build-essential
```
## Build for debug
### Build for debug
```bash
cargo build
```
## Build release
### Build release
```bash
cargo build --release
```
## Run
### Run
```bash
cargo run -- --mount-point MOUNT_POINT --data-dir DATA_DIR
Expand All @@ -284,8 +286,7 @@ cargo run -- --mount-point MOUNT_POINT --data-dir DATA_DIR
See here how to configure for [VsCode](https://code.visualstudio.com/docs/devcontainers/containers)
And here for [RustRover](https://www.jetbrains.com/help/rust/connect-to-devcontainer.html)
You can use the `.devcontainer` directory from the project to start a container with all the necessary tools to build
and run the app.
You can use the `.devcontainer` directory from the project to start a container with all the necessary tools to build and run the app.
# Future
Expand Down

0 comments on commit 345c327

Please sign in to comment.