Installation Instructions
*************************
Copyright (C) 2026 Asher Mullaney <asher.mullaney@gmail.com>

This file is free documentation; Asher Mullaney gives
unlimited permission to copy, distribute, and modify it.

# INSTALLING gignore #



## PREREQUISITES ##

You must have the following on your system:
- Rustup Rust toolchains. These are toolchains including things like Rust std, the Rust compiler, the Rust compiler frontend, and many other essential tools.
  You can install them by following the instructions at [https://rust-lang.org/tools/install](https://rust-lang.org/tools/install). The site is viewable with GUI + Javascript browsers and also Lynx.
  It may work with other non-graphical browsers.
  The default toolchains require ~2GiB of disk space, so you should select "Customise Installation" and change the profile to "minimal" during the rustup installation.
- A GNU/Linux operating system. gignore has been tested on a Raspberry Pi 5 running RPi-OS 12 (Bookworm), but will almost certainly work on any other GNU/Linux distro, and will possibly work on other Unix-like systems.
  gignore will NOT work on Microsoft Windows.
- `libc` AND/OR `glibc`. Either one of these is pre-installed on pretty much every computer ever. You shouldn't need to worry about these.
- **Did you remember to verify the signature?**



## Quick Install ##

There are three simple steps to quickly install gignore:
1. `cd` to the directory containing this file.
2. `$ ./configure` (This creates the Makefile after checking the required prerequisites.)
3. `$ make` (This compiles gignore.)
4. `$ make install` (This installs gignore and creates the required assets. It MUST BE RUN AS ROOT.)



## Manual Install ##

1. `cd` to the directory containing this file.
2. Run `cargo build --release" to compile, assemble, and link the program.
3. The binary will be generated as `./target/release/gignore`.
4. Apply the correct permissions (root:root 755) to the binary and place it in the binary directory of your choice; `/usr/bin/` works well for me.



## After Install ##

After you've installed gignore, you may delete this directory. You may also remove rustup by running `$ rustup self uninstall`, as long as gignore is compiled and the binary is where you want it.



## Uninstalling ##

Simply remove the gignore binary. Also delete this directory and the rustup toolchains, by following the instructions above ("After Install") if you haven't done so already.

THANK YOU FOR USING gignore!
