Dan Anglin
23ec6048b5
- Converted documentation from Asciidoc to Markdown - Updated the installation instructions and moved to a separate file in the docs directory. - Updated the login instructions and moved to the Getting Started guide in the docs directory. - Updated the licensing information in the main README. - Created a page for changelog. - Create a page for the user manual.
44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
|
|
|
|
SPDX-License-Identifier: CC-BY-4.0
|
|
-->
|
|
|
|
# Enbas
|
|
|
|
### Overview
|
|
|
|
Enbas is a [GoToSocial](https://docs.gotosocial.org/en/latest/) client for your terminal written
|
|
in [Go](https://go.dev).
|
|
|
|
The project is in its early stages of development so expect bugs, breaking changes and limited
|
|
functionality.
|
|
At this time it is not recommended for use this with your production GoToSocial instances.
|
|
|
|
### Repository mirrors
|
|
|
|
Enbas is actively developed in [Code Flow](https://codeflow.dananglin.me.uk/apollo/enbas) with
|
|
the `main` branch mirrored to [Codeberg](https://codeberg.org/dananglin/enbas) and
|
|
[GitHub](https://github.com/dananglin/enbas).
|
|
|
|
### Documentation
|
|
|
|
- **[Installation guide](./docs/install.md)**: A guide for installing Enbas on your machine.
|
|
- **[Getting started guide](./docs/getting_started.md)**: A guide to help you get started on using Enbas.
|
|
- **[Configuration reference](./docs/configuration.md)**: The configuration reference documentation.
|
|
- **[User manual](./docs/manual.md)**: The user manual.
|
|
|
|
### Licensing
|
|
|
|
Each file is annotated with the licensing information, but in general:
|
|
|
|
- All original source code is licensed under GPL-3.0-or-later.
|
|
- All documentation is licensed under CC-BY-4.0.
|
|
|
|
### Inspirations
|
|
|
|
This project was inspired by the following projects:
|
|
|
|
* **[madonctl](https://github.com/McKael/madonctl)**: A Mastodon CLI client written in Go.
|
|
* **[tut](https://github.com/RasmusLindroth/tut)**: A Mastodon TUI written in Go.
|
|
* **[toot](https://pypi.org/project/toot/)**: A Mastodon CLI and TUI written in Python.
|