diff --git a/README.md b/README.md index 7604bd7e5f..5b8a69d388 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,7 @@ Current features: Being MIT licensed, RedoxFS can be bundled on GPL-licensed operating systems (Linux, for example). -### How to mount a partition - -- Install RedoxFS +### Install RedoxFS ```sh cargo install redoxfs @@ -28,7 +26,7 @@ cargo install redoxfs You can also build RedoxFS from this repository. -- Configure your storage device to allow rootless usage +### Configure your storage device to allow rootless usage If you are on Linux you need root permission to acess block devices (storage), but it's recommended to run RedoxFS as rootless. @@ -38,11 +36,17 @@ To do that you need to configure your storage device permission to your user wit sudo setfacl -m u:your-username:rw /path/to/disk ``` -- Mount your RedoxFS partition +### Create, mount and customize your RedoxFS partition -```sh -redoxfs /path/to/disk /path/to/mount -``` +See [the instructions in the book](https://doc.redox-os.org/book/redoxfs.html) for RedoxFS tooling usage. + +Currently RedoxFS tooling are: + +- `redoxfs` mount a RedoxFS disk +- `redoxfs-ar` write files to a RedoxFS disk +- `redoxfs-clone` clone a RedoxFS disk +- `redoxfs-mkfs` create an empty RedoxFS disk +- `redoxfs-resize` resize a RedoxFS disk [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![crates.io](http://meritbadge.herokuapp.com/redoxfs)](https://crates.io/crates/redoxfs)