search

iost-official / iost-docs

Documentation of iost
14 stars 21 forks source link

Install instructions for Ubuntu/Linux use brew when they should use apt #12

Open jimoquinn opened 5 years ago

jimoquinn commented 5 years ago

It is my opinion that dependencies should be very easy to install so developers spend their time writing code with IOST, not wrestling with the development environment.

The Ubuntu/Linux instructions for installing "git lfs" use brew, which may be fine, but apt is used throughout the install instructions for Ubuntu/Linux and brew is not. Here is the location: https://github.com/iost-official/iost-docs/blob/master/docs/4-running-iost-node/Environment-Configuration.md

Also, apt is native to the OS and brew is not.

QwertyJack commented 5 years ago

That page is out-of-date. We are working on the new one. Thanks anyway.

jimoquinn commented 5 years ago

Fair enough, I will wait on the new docs

I do have one request and that is to include the version number right at the top of the README.md. Impossible to determine what version is in github because you're not using releases and no one wants to clone the repository and build the site simply to figure out if they have the latest docs or not.

I'm closing this issue, reopen if necessary.

jimoquinn commented 5 years ago

Closing.

QwertyJack commented 5 years ago

@jimoquinn Instructions for CentOS 7 is up-to-date. We would appreciate if you could help with that for OS/X & Ubuntu.