Skip to content

Commit

Permalink
update README.md, add user documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
doriancodes committed Dec 16, 2024
1 parent d9157d7 commit 3906f43
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 5 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,40 @@

Simple file system implementation using the 9P protocol

## Installation

### Prerequisites

- This project only works on Unix-based systems (Linux, macOS)
- FUSE must be installed on your system:

**Ubuntu/Debian:**
```bash
sudo apt-get install fuse
```

**macOS:**
```bash
brew install macfuse
```
Note: On macOS, you may need to allow the system extension in System Preferences > Security & Privacy after installing macFUSE.

**Fedora:**
```bash
sudo dnf install fuse
```

**Arch Linux:**
```bash
sudo pacman -S fuse
```

### Using Cargo

```bash
cargo install froggr
```

## User Guide

The user guide is available online at [doriancodes.github.io/froggr](https://doriancodes.github.io/froggr/) and can be built locally using [mdBook](https://rust-lang.github.io/mdBook/). To build and serve the documentation locally:
Expand Down
37 changes: 32 additions & 5 deletions docs/src/reference/installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,42 @@
# Installation

## System Requirements

- Unix-based operating system (Linux, macOS)
- Linux kernel 4.18 or later
- FUSE filesystem support

## Installing FUSE

Before installing froggr, you need to install FUSE on your system:

### Ubuntu/Debian
```bash
sudo apt-get install fuse
```

### macOS
```bash
brew install macfuse
```
Note: On macOS, you may need to allow the system extension in System Preferences > Security & Privacy after installing macFUSE.

### Fedora
```bash
sudo dnf install fuse
```

### Arch Linux
```bash
sudo pacman -S fuse
```

## From Source

### Prerequisites
- Rust toolchain (1.70 or later)
- Cargo package manager
- FUSE installed (see above)

### Steps

Expand Down Expand Up @@ -36,8 +68,3 @@ After installation, verify that froggr is working correctly:
```shell
frg --version
```

## System Requirements

- Linux kernel 4.18 or later
- FUSE filesystem support

0 comments on commit 3906f43

Please sign in to comment.