Skip to content

Commit

Permalink
update the nu-themes readme (nushell#652)
Browse files Browse the repository at this point in the history
related to
-
https://discord.com/channels/601130461678272522/601130461678272524/1167879553918705705

## description
this PR updates the README of the `nu-themes` module in the `nu-scripts`
package:
- fix the path with `themes/nu-themes/` instead of `themes/themes/`
- adds some instructions to use `nupm`

> **Note**
> see the [new README
here](https://github.com/amtoine/nu_scripts/tree/update-nu-themes-readme/themes#use-a-colorscheme)
  • Loading branch information
amtoine committed Oct 29, 2023
1 parent 310b1df commit 8add04d
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions themes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,45 @@
Credit to @lemnos and [all contributors](https://github.com/lemnos/theme.sh/blob/master/CREDITS.md).

## Use a colorscheme
### The manual way
Currently, the theme change has to be a bit manual.
To have access to the list of all the themes,
```rust
ls ./themes/themes
ls ./themes/nu-themes
```

To use the `dracula` theme for instance, please run
```rust
use ./themes/themes/dracula.nu
use ./themes/nu-themes/dracula.nu
$env.config = ($env.config | merge {color_config: (dracula)})
```

The theme should be activated!

### Using Nupm
- install [Nupm] by following the [Nupm instructions]
- download the `nu_scripts` repository
```shell
git clone https://github.com/nushell/nu_scripts
```
- activate the `nupm` module with `use nupm`
- install the `nu-scripts` package
```nushell
nupm install --path --force nu_scripts
```

> **Note**
> installing the `nu-scripts` package will install `nu-themes` and other modules

- now, add the following in your config
```nushell
use nu-themes/nushell-dark.nu
$env.config.color_config = (nushell-dark)
```

## Screenshots

Here are [screenshots](./screenshots/README.md) of our themes.

[Nupm]: https://github.com/nushell/nupm
[Nupm instructions]: https://github.com/nushell/nupm#recycle-installation-toc

0 comments on commit 8add04d

Please sign in to comment.