|
|
@@ -1,10 +1,68 @@
|
|
|
# issues - a queer little tui for the poor mans issue tracker spec
|
|
|
|
|
|
-## Usage
|
|
|
+> Made with love, under employment, and queer joy. Proudly made without AI.
|
|
|
|
|
|
-```
|
|
|
-issues PATH
|
|
|
-```
|
|
|
+## What is issues.go?
|
|
|
+
|
|
|
+Put simply, `issues.go` is a TUI application for simple issue tracking (or
|
|
|
+whatever you can think of) using plain text files, folders, and no fancy tech.
|
|
|
+
|
|
|
+No web servers, no extra software, files that even Notepad.exe can deal with
|
|
|
+that integrate perfectly with your version control.
|
|
|
+
|
|
|
+> Wanna track some goals? `issues ~/goals`
|
|
|
+
|
|
|
+> Wanna track some bugs in a script your writing? `issues "that damn bug"`
|
|
|
+
|
|
|
+> Wanna browse a collection of issues? `issues some-bugs/`
|
|
|
+
|
|
|
+> Wanna track your issues with git? `git add issues/`
|
|
|
+
|
|
|
+> Wanna pull a remote issues repo? `git clone $REMOTE_REPO remote-issues`
|
|
|
+
|
|
|
+### huh?
|
|
|
+
|
|
|
+In further detail, issues.go is a series of utilities for interacting with [the
|
|
|
+Poorman's Issue Tracker spec][poorman] written in go for an efficient, small,
|
|
|
+and concurrent by default software.
|
|
|
+
|
|
|
+Predominantly, `issues.go` provides a convenient TUI for creating, editing,
|
|
|
+viewing and browsing collections of ["Issues"][poorman]. `issues.go` provides
|
|
|
+the bindings for standard execution of this TUI in `cmd/issues.go`. For more,
|
|
|
+see the usage below.
|
|
|
+
|
|
|
+Additionally, `issues.go` provides a public interface for integration with your
|
|
|
+own software. For more own this interface, see the `go doc`
|
|
|
+
|
|
|
+## Why make it? Doesn't GitHub do this?
|
|
|
+
|
|
|
+All software is political. Everything you make is political.
|
|
|
+
|
|
|
+We dislike the Embrace, Extend, Extinguish implementation of the likes of
|
|
|
+GitHub's issue tracking. Embrace radically simple software, reduce headaches.
|
|
|
+
|
|
|
+### k but... why bring all this gay shit into it?
|
|
|
+
|
|
|
+All software is political. Everything you make is political.
|
|
|
+
|
|
|
+We, as a collective, are [neuroqueer][neuroqueer]. This software was made [to
|
|
|
+queer][queer] the status quo of requiring complicated high tech solutions for
|
|
|
+things that should be simple.
|
|
|
+
|
|
|
+Software should, at best, be able to run on a potato - right? So why should
|
|
|
+you need to have some complicated web server that someone else owns with features
|
|
|
+designed to lock you in... Just to track some text?
|
|
|
+
|
|
|
+Well we don't have fancy network stacks or money for hosting. We have old phones
|
|
|
+and some old trash computer we fished out of the recycling. You might not even
|
|
|
+have that!
|
|
|
+
|
|
|
+So what, who cares about hosting it yourself right?
|
|
|
+
|
|
|
+Idunno. The more all of the major companies insist on shoving LLM's down
|
|
|
+our throats, inflating the load the industry places on the environment
|
|
|
+exponentially. Why should my software have to burn a tree every time I want to
|
|
|
+add some info to an issue we're working?
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
@@ -12,6 +70,12 @@ issues PATH
|
|
|
go install cmd/issues.go
|
|
|
```
|
|
|
|
|
|
+## Usage
|
|
|
+
|
|
|
+```
|
|
|
+issues PATH
|
|
|
+```
|
|
|
+
|
|
|
## TODO
|
|
|
|
|
|
- `cmd/issues.go:// TODO implement edit/delete functions`
|
|
|
@@ -30,10 +94,16 @@ go install cmd/issues.go
|
|
|
|
|
|
## See also
|
|
|
|
|
|
-- [The Poorman Issue Tracker Spec](https://github.com/driusan/PoormanIssueTracker)
|
|
|
+- [The Poorman Issue Tracker Spec][poorman]
|
|
|
- [Bubbletea/bubbles input field](https://github.com/charmbracelet/bubbles/textinput)
|
|
|
+- [queer: (verb)][queer]
|
|
|
+- [neuroqueer][queer]
|
|
|
|
|
|
## license
|
|
|
|
|
|
For versions moving from v0.0.4, see the `LICENSE` file. All revisions previous
|
|
|
to version and revision v0.0.4 are subject to the MIT license.
|
|
|
+
|
|
|
+[poorman]: https://github.com/driusan/PoormanIssueTracker
|
|
|
+[queer]: https://www.merriam-webster.com/dictionary/queer#dictionary-entry-3
|
|
|
+[neuroqueer]: https://neuroqueer.com/neuroqueer-an-introduction/
|