search

evilmartians / oklch-picker

Color Picker for LCH
https://oklch.com
Other
849 stars 65 forks source link

Change confusing instructions in README #53

Closed vyadl closed 2 years ago

vyadl commented 2 years ago

Instructions in README wasn't clear and understandable about what the project needs. There was a confusing feeling that asdf is needed for this project, also because there are 2 first points about that. But basically it's optional and we need what asdf could give to us.

Also, second point is pointless at all

  1. Install Node.js and pnpm by asdf or manually:

    asdf install

There are completely different ways how to install asdf and also installing plugins and environment path variables, so the command asdf install is useless and confusing, as I see.

ai commented 2 years ago

We asdf is optional? We use asdf config as a lock file for Node.js/pnpm versions.

vyadl commented 2 years ago

As I saw (and as it was written) in README, it can be used asdf for installing nodejs and pnpm but it also could be installed manually. That's why I understood it like optional. Maybe the idea was different initially, I don't now. If it's not optional, I think it could be better to rewrite this instruction in some way to prevent misunderstanding.

ai commented 2 years ago

We can add a note that you can install tools manually but check versions in this config