Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
caprilesport committed Jan 15, 2024
1 parent 5e54528 commit c4f6e57
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,68 @@ features that support your needs, or clone the repo `=)`.

## Installation

### Requirements

Before installing `gedent`, through `cargo`
you need to make sure you have
[Rust](https://www.rust-lang.org/tools/install) (version 1.65.0 or later)
and [Cargo](https://doc.rust-lang.org/cargo/),
the package manager for Rust,
installed.

If you dont already have rust and cargo installed, you can [install them with rustup](https://www.rust-lang.org/tools/install):

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

### From [crates.io](https://crates.io/crates/gedent)

Once you have Rust and Cargo installed,
you can install `gedent` from [crates.io](https://crates.io/) using Cargo:

```bash
cargo install gedent
```

This will download the necessary dependencies,
compile the `gedent` binary,
and install it in your system.

### Directly from [GitHub](https://github.com/caprilesport/gedent)

Alternatively,
you can install `gedent` directly from the GitHub repository
using Cargo by running:

```bash
cargo install --git=https://github.com/caprilesport/gedent.git
```

### By cloning the GitHub repository

You can also build `gedent` from source by cloning the GitHub repository
and running `cargo build`:

```bash
git clone https://github.com/caprilesport/gedent.git
cd gedent
cargo build --release
```

After building,
the binary will be located at `target/release/gedent`.

Do note that the config directory is not create this way, so if you're on linux, please create the
~/.config/gedent directory and copy the appropriate files and directories there:

```bash
mkdir ~/.config/gedent
cp $PWD/templates ~/.config/gedent/
cp $PWD/presets ~/.config/gedent/
cp $PWD/gedent.toml ~/.config/gedent/
```

## Configuration

`gedent` offers support for a per-project configuration file, it searches previous
Expand Down

0 comments on commit c4f6e57

Please sign in to comment.