mirror of
https://github.com/RGBCube/nu_scripts
synced 2025-08-01 14:47:47 +00:00
refactor: ✨ (#418)
* refactor: ✨ move in one commit Eveything in modules should probably be changed to `exported` defs. The idea is to move everything first to keep proper history. * refactor: 📝 add modules readme (wip) * refactor: ✨ small move * refactor: 📝 changed nestring, updated modules readme * refactor: 📝 to document or not to document * fix: 🐛 themes replaced the template to use `main` and regenerated them from lemnos themes. * Revert "fix: 🐛 themes" This reverts commit 4918d3633c8d2d81950a0ed0cfd9eb84241bc886. * refactor: ✨ introduce sourced - Created a source `root` in which sourcable demos are stored. Some might get converted to modules later on. - Moved some files to bin too. * fix: 🐛 fehbg.nu * fix: 🐛 modules/after.nu * moved some other stuff around --------- Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com>
This commit is contained in:
parent
382696cd21
commit
c47ccd42b8
128 changed files with 185 additions and 12 deletions
59
sourced/TODO.md
Normal file
59
sourced/TODO.md
Normal file
|
@ -0,0 +1,59 @@
|
|||
# todo
|
||||
|
||||
These two commands can be used to make simple todo-lists that
|
||||
are printed to the screen at terminal startup. They are currently
|
||||
only implemented for [alacritty], for other terminals consult
|
||||
your terminal documentation or find a work around
|
||||
|
||||
## SETUP:
|
||||
- Create a file called `todo.nu` and place the `printer` command,
|
||||
calling it at the end.
|
||||
- In your `alacritty.yml`, add this
|
||||
```yml
|
||||
shell:
|
||||
program: /bin/nu # path to your `nu` executable
|
||||
args:
|
||||
- -e "nu /path/to/todo.nu"
|
||||
```
|
||||
- Create an empty file called `todo.txt`
|
||||
- *Recommended*
|
||||
In your `env.nu`, add an environment variable pointing to the `todo.txt`. Example:
|
||||
```nu
|
||||
let-env TODO = ($nu.config-path | path dirname | path join 'scripts/todo.txt')
|
||||
```
|
||||
- Source the `todo` command in your `config.nu`. Example
|
||||
```nu
|
||||
source './scripts/todo.nu'
|
||||
```
|
||||
## USAGE:
|
||||
- On terminal startup, the printer command is run by `nu` and the
|
||||
list is printed to the screen. If the list is empty, a message
|
||||
indicating so is printed.
|
||||
|
||||
- To add items,
|
||||
```nu
|
||||
todo -a "finish writing docs"
|
||||
```
|
||||
|
||||
- To remove an item
|
||||
```nu
|
||||
# this prints the list(numbered)
|
||||
todo
|
||||
# the index of the item you want to remove
|
||||
# (starts at 1 but can be changed to start at 0)
|
||||
todo -r 4
|
||||
```
|
||||
|
||||
- To clear the whole list
|
||||
```nu
|
||||
todo -c
|
||||
```
|
||||
|
||||
- To manually edit the list
|
||||
```
|
||||
# this opens an editor with the file opened
|
||||
todo -e
|
||||
```
|
||||
|
||||
|
||||
[alacritty]: github.com/alacritty/alacritty
|
Loading…
Add table
Add a link
Reference in a new issue