2
1
Fork 0
Project management swim lanes for your terminal https://sloum.colorfield.space/docs/swim
Go to file
sloum 67eae4866c Adds mode for removing colors 2021-03-26 09:15:07 -07:00
termios Some screen drawing is happening now but it is janky 2021-03-22 22:46:01 -07:00
.gitignore Fixes a number of small details and reworks some shortcut keys 2021-03-25 09:26:45 -07:00
LICENSE Adds license, fixes bugs, adds features 2021-03-25 15:53:22 -07:00
Makefile Adds makefile 2021-03-26 00:09:17 +00:00
README.md Updates readme 2021-03-26 00:38:32 +00:00
board.go Adds license, fixes bugs, adds features 2021-03-25 15:53:22 -07:00
colors.go Adds mode for removing colors 2021-03-26 09:15:07 -07:00
comment.go More or less working board 2021-03-24 23:22:54 -07:00
go.mod Adds go.mod 2021-03-25 17:47:03 +00:00
lane.go Adds license, fixes bugs, adds features 2021-03-25 15:53:22 -07:00
main.go Adds mode for removing colors 2021-03-26 09:15:07 -07:00
notes.md Some screen drawing is happening now but it is janky 2021-03-22 22:46:01 -07:00
story.go Auto-color detection and shortcut for description edit 2021-03-25 23:02:27 -07:00
task.go More or less working board 2021-03-24 23:22:54 -07:00

README.md

swim - project board software

swim is a project/task management helper that organizes projects into "swim lanes". The lanes can contain "stories" that represent a subproject. These subprojects can have titles, descriptions, assigned users, a point representation of their difficulty, a task list, and comments. Stories can be moved around within and between lanes to represent their current state in the project. A common layout for simple projects is to have three lanes: backlog, active, complete; but many other working models are possible.

Building and Installing

You will need a Go compiler. Testing on early versions has not been done, but suffice to say you should likely not need the latest cutting edge Go version to compile swim.

A Makefile has been provided with targets for make to just build in the local directory and [sudo] make install to install on the system along with the manpage. If you do not care about the manpage you can run go build or go install.

Usage

swim has a decent sized, and growing, number of commands and "hot" keys. They will be detailed in this section, but are also avialable via the manpage.