Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alvinrizki-gtf committed Dec 23, 2022
1 parent e300cb0 commit 853e98f
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
# ntfs-wr
Simple CLI to mount and enable write on NTFS file system easily on MacOS
Simple CLI to mount and enable write on NTFS file system easily on MacOS.

Tested on:
1. Macbook Pro 14", M1 Pro, 16GB ram, MacOS Monterey 12.6.1

## Requirements

## Installation

```bash
$ go install github.com/cikupin/ntfs-wr
```

## Usage

1. See list of commands
```bash
$ ntfs-wr --help
```

2. List external drive with NTFS file system
```bash
$ ntfs-wr list
```

3. Mount external NTFS partition (you need to run as root)
```bash
$ sudo ntfs-wr mount
```

4. Open NTFS mounted volume. You must do copy-paste on this directory.
```bash
$ ntfs-wr open <volume dir name>
```

4. Unmount mounted volume (you need to run as root)
```bash
$ sudo ntfs-wr unmount <volume dir name>
```

## To do plan

Expand Down

0 comments on commit 853e98f

Please sign in to comment.