diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a6c8ed4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +neofeels +doc/neofeels.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6447041 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Copyright (c) 2025 nbsp@tilde.town + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..153fd79 --- /dev/null +++ b/Makefile @@ -0,0 +1,21 @@ +GO ?= go +RM ?= rm +SCDOC ?= scdoc + +all: neofeels doc + +neofeels: + $(GO) build $(GOFLAGS) . + +# ifeq (, $(shell which $(SCDOC) 2>/dev/null)) +# $(warning "$(SCDOC) not found, skipping building documentation") +doc: +# else +# doc: doc/neofeels.1 +# $(SCDOC) < doc/neofeels.1.scd > doc/neofeels.1 + +clean: + rm neofeels doc/neofeels.1 + +.PHONY: all neofeels doc clean + diff --git a/README.md b/README.md new file mode 100644 index 0000000..211258c --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# neofeels + +a new ttbp client + +## building + +``` +git clone https://git.tilde.town/nbsp/neofeels +cd neofeels +make +``` + +## roadmap + +- [x] main menu +- [x] credits +- [ ] feels browser +- [ ] configuration editor +- [ ] feels publishing +- [ ] graffiti +- [ ] feedback +- [ ] documentation with manpages + +nice-to-haves: +- [ ] mouse support +- [ ] image support via sixels + +## contributing + +contributions are welcome! please feel free to open a PR to add any missing +features. i aim to make neofeels eventually completely-feature complete with +feels. + +## license + +neofeels is licensed under the MIT license. refer to [the license](LICENSE) for +details.