sloum
/
swim
2
1
Fork 0
Code Releases Activity

Minor readme updates

This commit is contained in:
sloum 2021-03-26 23:06:43 -07:00
parent e02b21076b
commit 144d5cce87
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -32,10 +32,10 @@ These keys have the following effect while looking at the main 'swim lane' view:
- `j` - Move focus one story down
- `k` - Move focus one story up
- `l` - Move focus one lane to the right
- 'H' - Move focused story one lane to the left
- 'J' - Move focused story one story down in the current lane
- 'K' - Move focused story one story up in the current lane
- 'L' - Move focused story one lane to the right
- `H` - Move focused story one lane to the left
- `J` - Move focused story one story down in the current lane
- `K` - Move focused story one story up in the current lane
- `L` - Move focused story one lane to the right
- `Q` - Quit swim immediately
- `N` - Create a new lane, will query for lane name
- `n` - Create a new story in the focused lane, will query for story name
@ -133,3 +133,11 @@ That last one, `none`, will never be used automatically, but can be passed with
_swim_ will automatically resize and redraw when your terminal is resized. It also handled common signals well, allowing for suspend/resume job control to work nicely and for other signals (^c and ^d come to mind) to behave as expected.
## Examples
A file, `swim.json`, is included with this repository. It has been used to track work on the project itself (at least since file i/o was added) and can serve as a simple example and a way to try navigating around the program with some data already present.
## License
A license file is included in the repo. If for some reason you have this readme but not the license file, it can be viewed on the web via [floodgap](https://www.floodgap.com/software/ffsl/license.html).