Skip to content

Commit

Permalink
Fix readme for installation on first release (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
caprilesport authored Jan 17, 2024
1 parent 8c884ce commit 1ac6d93
Showing 1 changed file with 18 additions and 21 deletions.
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,41 +38,38 @@ If Rust and Cargo are not already installed, you can conveniently set them up us
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

### Installing from [crates.io](https://crates.io/crates/gedent)
### Installation

Once Rust and Cargo are in place, `gedent` can be installed from [crates.io](https://crates.io/) using Cargo:
To install `gedent` we will build it from source by cloning the GitHub repository
and running `cargo build`:

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

This command downloads necessary dependencies, compiles the `gedent` binary, and installs it on your system.

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

Alternatively,
you can install `gedent` directly from the GitHub repository
using Cargo by running:
After building,
the binary will be located at `target/release/gedent`, to make it available system-wide,
you can symlink it to somewhere in your `$PATH`, e.g.:

```bash
cargo install --git=https://github.com/caprilesport/gedent.git
sudo ln -s $PWD/target/release/gedent /usr/local/bin
```

### By cloning the GitHub repository
After installing, the only thing left to do is copy the `templates` and
`presets` directories, as well as the gedent.toml file to your system
configuration directory.

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

```bash
git clone https://github.com/caprilesport/gedent.git
cd gedent
cargo build --release
mkdir ~/.config/gedent
cp -r ./templates ~/.config/gedent/
cp -r ./presets ~/.config/gedent/
cp ./gedent.toml ~/.config/gedent
```

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


## Configuration

`gedent` supports per-project configuration files. If no config file (`gedent.toml`) is found in the current directory or its parent directories, the tool defaults to using the configuration at `~/.config/gedent` on Linux.
Expand Down

0 comments on commit 1ac6d93

Please sign in to comment.