openheimer icon indicating copy to clipboard operation
openheimer copied to clipboard

There is no documentation on how to use OpenHeimer

Open Onako2 opened this issue 2 years ago • 12 comments

There is not documentation how to use openheimer It would be useful to explain how to install/use it

Onako2 avatar Feb 13 '23 17:02 Onako2

Yea I'll probably do that after #2 I'll also provide pre-compiled binaries for those who don't want to set up a Go/Rust environment manually

But for now:

First you need to install the Go compiler (https://go.dev) Then, compile the project using the go build command Finally, run the openheimer.exe executable

Really easy.

And if you want custom flags, just pass them by using openheimer.exe -flag value

ErrorNoInternet avatar Feb 13 '23 19:02 ErrorNoInternet

Thanks for the fast reply!

Onako2 avatar Feb 13 '23 19:02 Onako2

Would still like to keep this open though, there is no clear documentation yet

ErrorNoInternet avatar Feb 13 '23 19:02 ErrorNoInternet

ok 👍

Onako2 avatar Feb 13 '23 19:02 Onako2

What abt on a Linux Server?

flufferyomada avatar Feb 18 '24 17:02 flufferyomada

Only thing that would be different is the file extension and Go installation method

e.g.

sudo pacman -S go git clone ... && cd ... go build ./openheimer

ErrorNoInternet avatar Feb 18 '24 18:02 ErrorNoInternet

Could I attempt to make a basic documentation? (Haven't done that before, would like to try this)

PainfulPaladins avatar May 14 '24 15:05 PainfulPaladins

Could I attempt to make a basic documentation? (Haven't done that before, would like to try this)

Why not? It is always better to try than not to try

Onako2 avatar May 14 '24 16:05 Onako2

For the download, should I list the binaries in the release or are they outdated?(will probably include how to build it too)

PainfulPaladins avatar May 15 '24 11:05 PainfulPaladins

The binaries in the releases are from the rust (rewrite) branch, not the currently-working main branch. For that you have to compile it yourself.

ErrorNoInternet avatar May 15 '24 12:05 ErrorNoInternet

Oh my bad. I should probably make the documentation on the working branch then.

PainfulPaladins avatar May 16 '24 12:05 PainfulPaladins

started on #9

PainfulPaladins avatar May 16 '24 15:05 PainfulPaladins