cleaned up main README

README.asciidoc

@@ -1,87 +0,0 @@
-// SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
-//
-// SPDX-License-Identifier: CC-BY-4.0
-
-= Enbas
-:toc: left
-:toclevels: 3
-:toc-title: Table of Contents
-
-== Overview
-
-Enbas is a https://docs.gotosocial.org/en/latest/[GoToSocial] client for your terminal written
-in https://go.dev[Go].
-
-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 servers.
-
-This project is licensed under the GNU General Public License V3 or later which you can view link:LICENSES/GPL-3.0-or-later.txt[here].
-
-=== Repository mirrors
-
-Enbas is primarily developed in Code Flow https://codeflow.dananglin.me.uk/apollo/enbas[here] with the `main` branch pushed to
-https://codeberg.org/dananglin/enbas[Codeberg] and https://github.com/dananglin/enbas[GitHub]
-
-== Installation
-
-(Moved)
-
-== Configuration
-
-Enbas uses Go's https://pkg.go.dev/os#UserConfigDir[os.UserConfigDir()] function to determine the
-location of your configuration directory.
-
-If you've set the `XDG_CONFIG_HOME` environment variable, the configuration files will be stored in the `$XDG_CONFIG_HOME/enbas` directory.
-
-If this is not set:
-
-- on Linux the configuration directory will be set to `$HOME/.config/enbas`.
-- on Darwin (MacOS) the configuration directory will be set to `$HOME/Library/Application Support/enbas`.
-- on Windows the configuration directory will be set within the `%AppData%` directory.
-
-If, for whatever reason, any of the above cannot be determined the configuration directory will be set to
-the current working directory.
-
-== Usage
-
-=== Log into your GoToSocial account
-
-(Moved)
-
-=== Common actions
-
-* View your account information
-+
-[source,console]
-----
-enbas show --type account --my-account
-----
-
-* View a local or remote account
-+
-[source,console]
-----
-enbas show --type account --account teddy@gotosocial-01.social.example
-----
-
-* View your home timeline
-+
-[source,console]
-----
-enbas show --type timeline
-----
-
-* View the details of a status
-+
-[source,console]
-----
-enbas show --type status --status-id 01HQE43KT5YEDN4RGMT7BC63PF
-----
-
-== Inspirations
-
-This project was inspired by the following projects:
-
-* **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.]
-* **tut:** https://github.com/RasmusLindroth/tut[A Mastodon TUI written in Go.]

README.md

@@ -0,0 +1,42 @@
+<!--
+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)**: Follow this link to install Enbas.
+- **[Getting started guide](./docs/getting_started.md)**: Follow this link to go through the Getting started guide.
+
+### 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.

docs/changelog.md

@@ -0,0 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# Changelog

docs/getting_started.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 # Getting Started
 
 ## Summary

docs/install.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 # Installation
 
 ## Download
@@ -114,4 +120,4 @@ Go version: go1.22.4
 Build date: 2024-06-28T21:57:37Z
 ```
 
-Once you have completed the installation proceed to the [Getting Started guide](./getting-started.md).
+Once you have completed the installation proceed to the [Getting Started guide](./getting_started.md).

docs/manual.md

@@ -0,0 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# Manual