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.

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

Better installation instructions in the readme #10

Open
bmesuere opened this issue Nov 3, 2021 · 3 comments
Open

Better installation instructions in the readme #10

bmesuere opened this issue Nov 3, 2021 · 3 comments

Comments

@bmesuere
Copy link
Member

bmesuere commented Nov 3, 2021

The installation instructions in the readme should be a bit longer and also targeted towards non-computer scientists. The recommended way is probably using cargo. The instructions to compile it from source are missing.

@ninewise
Copy link

ninewise commented Nov 3, 2021

I'd actually recommend the binary installation to non-computer scientists.

I've made some changes in 7b554e5, could you check if this clarifies the instructions? I've split the "from source" instructions in two parts so it's more visible that the crates.io is a source release as well.

@bmesuere
Copy link
Member Author

bmesuere commented Nov 3, 2021

But binary is not easy to update?

@ninewise
Copy link

ninewise commented Nov 3, 2021

It is indeed harder to automatically update; I've added update instructions as well now, and marked crates.io as recommended installation method.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants