tomo/tomo-old
tomo/tomo-old
Archived
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Sasha Koshka 2023-05-03 15:36:16 -04:00
parent 8d6deb3456
commit 7472cf52d9
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -6,11 +6,19 @@ Please note: Tomo is in early development. Some features may not work properly,
and its API may change without notice.
Tomo is a GUI toolkit written in pure Go with minimal external dependencies. It
makes use of Go's unique language features to do more with less. It is also
easily extendable with custom backends and elements.
makes use of Go's unique language features to do more with less.
You can find out more about how to use it by visiting the examples directory,
or pull up its documentation by running `godoc` within the repository. You can
also view it on the web on
[pkg.go.dev](https://pkg.go.dev/git.tebibyte.media/sashakoshka/tomo) (although
Nasin is an application framework that runs on top of Tomo. It supports plugins
which can extend any application with backends, themes, etc.
## Usage
Before you start using Tomo, you need to install a backend plugin. Currently,
there is only an X backend. You can run ./scripts/install-backends.sh to install
it. It will be placed in `~/.local/lib/nasin/plugins`.
You can find out more about how to use Tomo and Nasin by visiting the examples
directory, or pull up the documentation by running `godoc` within the
repository. You can also view it on the web on
[pkg.go.dev](https://pkg.go.dev/git.tebibyte.media/sashakoshka/tomo) (although
it may be slightly out of date).