apollo/enbas
1
0
Fork 0
Code Issues 4 Pull requests Projects Activity Actions
enbas/README.md

44 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

docs: updated documentation - 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.
2024-07-01 13:49:11 +01:00
# 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
docs(README): update mirrored forges Add Radicle as a forge (network) that the main branch is mirrored to.
2024-07-02 11:16:32 +01:00
the `main` branch mirrored to the following forges:
- **Codeberg**: https://codeberg.org/dananglin/enbas
- **Radicle**: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:zhqv2orTvTh2x2d7kYky9NhctrpK
- **GitHub**: https://github.com/dananglin/enbas
docs: updated documentation - 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.
2024-07-01 13:49:11 +01:00
### Documentation
docs: add the user manual The user manual: a page that users can reference when playing with Enbas.
2024-07-06 17:36:42 +01:00
- **[Installation guide](docs/installation.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.
feat(BREAKING): new parser for the TDV This commit adds a new parser for the internal time duration flag value (TimeDurationValue). Previously this used the parser from the time package from the standard library but this was limited to parsing units of time up to hours. The new parser allows users to specify duration in days, hours, minutes, seconds and a combination of the above. It is quite flexible in the way users format their string input. Additonal changes: - Added unit tests for the command-line parsing of the TimeDurationValue type. - Updated the unit tests for the BoolPtrValue type. - Updated documentation. PR: https://codeflow.dananglin.me.uk/apollo/enbas/pulls/55
2024-08-20 03:32:54 +01:00
- **[Tips and Tricks](docs/tips_and_tricks.md)**: Additional tips and tricks.
docs: updated documentation - 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.
2024-07-01 13:49:11 +01:00
### Licensing
chore: REUSE.toml - Replace .reuse/dep5 with the new REUSE.toml file. - Add licensing information to REUSE.toml and remove the licensing headers from the source files.
2024-08-01 04:01:38 +01:00
The licensing information associated with each file is specified in the [REUSE.toml](REUSE.toml) file,
but in general:
docs: updated documentation - 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.
2024-07-01 13:49:11 +01:00
- 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.
Reference in a new issue Copy permalink