checkpoint: update doc

This commit is contained in:
Dan Anglin 2024-02-25 15:09:32 +00:00
parent d001d99c0a
commit 12fa89e9be
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638

View file

@ -5,23 +5,45 @@
== Overview == Overview
Enbas is a https://docs.gotosocial.org/en/latest/[GoToSocial] client for the terminal. Enbas is a https://docs.gotosocial.org/en/latest/[GoToSocial] client for your terminal written
in https://go.dev[Go]. The project is currently a work in progress so breaking changes will be
made and bugs may appear here and there during its early development.
Enbas has limited functionality at the moment and it is **not** recommended for use
with your production GoToSocial servers.
This project is licensed under GPLv3.
=== Repository mirrors === Repository mirrors
- **Code Flow:** https://codeflow.dananglin.me.uk/apollo/enbas - **Code Flow:** https://codeflow.dananglin.me.uk/apollo/enbas
- **Codeberg:** https://codeberg.org/dananglin/enbas - **Codeberg:** https://codeberg.org/dananglin/enbas
- **GitHub:** TBC - **GitHub:** https://github.com/dananglin/enbas
== Installation == Installation
=== Download === Download
Pre-built binaries will be available on the release page on both Codeberg and GitHub when the first
release is made.
=== Build from source === Build from source
==== With mage ==== Requirements
==== With go build ===== Go
A minimum version of Go 1.22.0 is required for installing spruce.
Please go https://go.dev/dl/[here] to download the latest version.
===== Mage (Optional)
The project includes mage targets for building and installing the binary.
The main advantage of using mage is that the binary's build information is baked into the binary
during compilation. You can visit the https://magefile.org/[Mage website] for instructions on how to install Mage.
==== Install with mage
==== Install with go build
== Configuration == Configuration
@ -29,6 +51,8 @@ Enbas is a https://docs.gotosocial.org/en/latest/[GoToSocial] client for the ter
== Inspirations == Inspirations
This project was inspired from the following projects:
- **madonctl:** https://github.com/McKael/madonctl[A Mastodon CLI client written in Go.] - **madonctl:** https://github.com/McKael/madonctl[A Mastodon CLI client written in Go.]
- **toot:** https://pypi.org/project/toot/[A Mastodon CLI and TUI written in Python.] - **toot:** https://pypi.org/project/toot/[A Mastodon CLI and TUI written in Python.]
- **tut:** https://github.com/RasmusLindroth/tut[A Mastodon TUI written in Go.] - **tut:** https://github.com/RasmusLindroth/tut[A Mastodon TUI written in Go.]