Update README with simple build steps

The old autotools-based build doesn't work on modern systems.
This commit is contained in:
Multimedia Mike
2018-02-08 18:09:42 -08:00
committed by GitHub
parent e2abb45160
commit 2afdca87bf

View File

@ -1,3 +1,17 @@
# gcfuse - Use FUSE To Mount GameCube Filesystems
**Note (February, 2018):** The original build instructions below were written circa 2006 and are a bit obsolete. This source code should still compile and run on modern Linux kernels using this process:
1. Be sure to have FUSE libraries installed (as of Ubuntu 16.04, this package is 'libfuse-dev')
2. Clone this repository
3. Execute the following build command:
```gcc -D_FILE_OFFSET_BITS=64 -Wall src/gcfs.c src/main.c src/tree.c -o gcfs -lfuse```
This will build the binary executable ```gcfs```. Use the *Usage* section below for instructions on running this utility.
---
gcfuse is a program that allows you to mount a Nintendo GameCube DVD gcfuse is a program that allows you to mount a Nintendo GameCube DVD
disk image as a read-only part of the Linux filesystem. This allows the disk image as a read-only part of the Linux filesystem. This allows the
user to browse the directory structure and read the files within. user to browse the directory structure and read the files within.
@ -16,18 +30,28 @@ tool for studying GameCube discs.
Requirements: Requirements:
```
- Linux 2.4.x or 2.6.x (as of 2.6.14 FUSE is part of the - Linux 2.4.x or 2.6.x (as of 2.6.14 FUSE is part of the
kernel, but you still need user libraries) kernel, but you still need user libraries)
- FUSE (http://fuse.sourceforge.net) 2.5.x or higher - FUSE (http://fuse.sourceforge.net) 2.5.x or higher
```
Build: Build:
```
./configure && make ./configure && make
```
Install: Install:
```
make install make install
```
Usage: Usage:
```
gcfuse <image_file.gcm> <mount_point> gcfuse <image_file.gcm> <mount_point>
```
To unmount previously mounted file, use: To unmount previously mounted file, use:
```
fusermount -u <mount_point> fusermount -u <mount_point>
```