Clean up README #5718
Clean up README #5718
Conversation
|
thanks. it's been needing this pass through for a while. although, I think I'd vote to keep the installation section. |
There was a problem hiding this comment.
One suggestion maybe add a TOC at the top to quickly navigate to either pages in the same readme or to the appropriate page like I did it for reedline. This way, we can keep the full installation information (if up to date) there but can keep the easy and interesting to read stuff at the top.
| > config set line_editor.edit_mode "vi" | ||
| > config set path $nu.path |
There was a problem hiding this comment.
Wow yeah that is out of date
README.md
Outdated
|
|
||
| You can also find information on more specific topics in our [cookbook](https://www.nushell.sh/cookbook/). | ||
| If you're a developer who would like to contribute to Nu, we're working on a [book for developers](https://www.nushell.sh/contributor-book/) to help you get started. There are also [good first issues](https://github.com/nushell/nushell/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) to help you dive in. |
There was a problem hiding this comment.
I think the Contributor book is not yet updated and thus this leads to a stub.
|
Thanks for the feedback; things got a bit busy over here but I’ll do another revision as soon as I have time. |
|
OK, did another pass. Notable changes:
It occurrect to me that the Philosophy section could use a rewrite; it's currently a bit crowded, has lots of info that doesn't really fit under "Philosophy". But I'll leave that for another time. |
|
Merging but just let me know if I got anything wrong. |
* Clean up README * Update CONTRIBUTING.md * Another pass over the README. Table of contents, more install info * add a little extra features definition * fix Winget instructions * Change winget instructions to nushell (easier to remember) Co-authored-by: Darren Schroeder <[email protected]>
Description
The README was getting very long and some places were out of date. I've done a pass to update out-of-date info and remove some info that the book covers better.