Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add step for compiling the program #52

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add step for compiling the program #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ https://config-gen-web.netlify.com/

---

## Step 1 - Download the binary
## Step 1a - Download the binary

To enable easy usage, `config-gen` is packaged as a single binary (currently only osx) - just check
the [releases](https://github.com/shakyShane/config-gen/releases) page and download the latest version.
Expand All @@ -30,8 +30,29 @@ To make it executable, run
chmod +x config-gen
```


**Note**: Some easier installation methods will be released in the coming weeks. :)

## Step 1b - Compile the binary

If you're using Linux, you'll need to compile the binary.

To compile the binary you need a few programs installed.
- `cargo`
- `rust`
- `openssl-dev` (debian/ubuntu) or `openssl-devel` (centos/fedora/rhel)

Compiling the binary is easy:

``` shell
git clone https://github.com/WeareJH/config-gen.git
cd config-gen
cargo build --release
```

After compiling, you'll find the binary in `target/release/config-gen`.


## Step 2 - create a configuration file (either `json` or `yaml`)

You can name it anything, but for example, this would be config-gen.yml
Expand Down