Metadata-Version: 2.3
Name: rogallo
Version: 0.1.0
Summary: Coming soon
Author: Dave Pearson
Author-email: Dave Pearson <davep@davep.org>
Requires-Dist: bagofstuff>=1.0.0
Requires-Dist: textual>=8.2.7
Requires-Dist: textual-enhanced>=1.5.0
Requires-Dist: wasat>=0.0.1
Requires-Dist: xdg-base-dirs>=6.0.2
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# Rogallo

## Introduction

Rogallo is a terminal-based client for [the Gemini
Protocol](https://geminiprotocol.net/). As of the time of writing it should
be considered to be very early alpha-quality software. What features it has
work well, but it is lacking a good number of features. It is in early
active development.

> [!important]
> This means, until it hits v1.0.0, any given update might be very different
> or might break things from the previous update. If you decide to try it
> out, please keep this in mind.

## Installing

### pipx

The application can be installed using [`pipx`](https://pypa.github.io/pipx/):

```sh
$ pipx install rogallo
```

### uv

The application can be installed using [`uv`](https://docs.astral.sh/uv/getting-started/installation/):

```sh
uv tool install rogallo
```

If you don't have `uv` installed you can use [uvx.sh](https://uvx.sh) to
perform the installation. For GNU/Linux or macOS or similar:

```sh
curl -LsSf uvx.sh/rogallo/install.sh | sh
```

or on Windows:

```sh
powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/rogallo/install.ps1 | iex"
```

Once installed run the `rogallo` command.

## File locations

Rogallo stores files in an `rogallo` directory within both [`$XDG_DATA_HOME`
and
`$XDG_CONFIG_HOME`](https://specifications.freedesktop.org/basedir-spec/latest/).
If you wish to fully remove anything to do with Rogallo you will need to
remove those directories too.

Expanding for the common locations, the files normally created are:

- `~/.config/rogallo/configuration.json` -- The configuration file.
- `~/.local/share/rogallo/*` -- The locally-held data.

## Getting help

If you need help, or have any ideas, please feel free to [raise an
issue](https://github.com/davep/rogallo/issues) or [start a
discussion](https://github.com/davep/rogallo/discussions).

## TODO

See [the TODO tag in
issues](https://github.com/davep/rogallo/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)
to see what I'm planning.

[//]: # (README.md ends here)
