extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-01-09 07:48:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

update the readme in the docs folder (#5065)

Browse Source 
* update docs/Readme

* tweak readme
This commit is contained in:
Michael Angerman 2022-04-01 13:48:09 -07:00 committed by GitHub
parent 80c9888f82
commit 62901573d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/README.md
View File

@ -1,5 +1,15 @@
# Documentation
Here is a collection of various pages documenting the changes made in engine-q which should probably end up in the book after we merge it to Nushell.
This directory contains [default_config.nu](./sample_config/default_config.nu)
which is the configuration file one gets when they startup Nushell for the first time.
Please see our [book](https://www.nushell.sh) for more complete documentation
It sets all of the default configuration to run Nushell. From here one can
then customize this file for their specific needs.
To see where *config.nu* is located on your system simply type this command.
```rust
$nu.config-path
```
Please see our [book](https://www.nushell.sh) for all of the Nushell documentation.