Metadata-Version: 2.3
Name: aging
Version: 0.2.0
Summary: A Norton Guide reader for the terminal
Project-URL: Homepage, https://blog.davep.org/aging/
Project-URL: Repository, https://github.com/davep/aging
Project-URL: Documentation, https://blog.davep.org/aging/
Project-URL: Source, https://github.com/davep/aging
Project-URL: Issues, https://github.com/davep/aging/issues
Project-URL: Discussions, https://github.com/davep/aging/discussions
Author-email: Dave Pearson <davep@davep.org>
License: GNU General Public License v3 or later (GPLv3+)
Keywords: chui,clipper,dbase,documentation,file-browser,file-viewer,help,ms-dos,norton-guide,terminal,tui,xbase
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: humanize>=4.12.1
Requires-Dist: ngdb>=0.8.0
Requires-Dist: pyperclip>=1.9.0
Requires-Dist: textual-enhanced>=0.7.1
Requires-Dist: textual-fspicker>=0.4.1
Requires-Dist: textual>=2.1.2
Requires-Dist: typing-extensions>=4.12.2
Requires-Dist: xdg-base-dirs>=6.0.2
Description-Content-Type: text/markdown

# AgiNG - A Norton Guide reader for the terminal

![AgiNG](https://raw.githubusercontent.com/davep/aging/refs/heads/main/.images/aging-social-banner.png)

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/davep/aging/style-and-lint.yaml)](https://github.com/davep/aging/actions)
[![GitHub commits since latest release](https://img.shields.io/github/commits-since/davep/aging/latest)](https://github.com/davep/aging/commits/main/)
[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/davep/aging)](https://github.com/davep/aging/issues)
[![GitHub Release Date](https://img.shields.io/github/release-date/davep/aging)](https://github.com/davep/aging/releases)
[![PyPI - License](https://img.shields.io/pypi/l/aging)](https://github.com/davep/aging/blob/main/LICENSE)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aging)](https://github.com/davep/aging/blob/main/pyproject.toml)
[![PyPI - Version](https://img.shields.io/pypi/v/aging)](https://pypi.org/project/aging/)

## Introduction

AgiNG is the latest in [a long line of Norton Guide tools and
readers](https://www.davep.org/norton-guides/) I've written, starting in the
1990s. It is designed to be as comprehensive as possible, keyboard-first but
mouse-friendly, and to look as good as possible.

## Installing

### pipx

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

```sh
$ pipx install aging
```

Once installed run the `aging` command.

### Homebrew

The package is available via Homebrew. Use the following commands to install:

```sh
$ brew tap davep/homebrew
$ brew install aging
```

Once installed run the `aging` command.

## Using AgiNG

The best way to get to know AgiNG is to read the help screen. Once in the
application you can see this by pressing <kbd>F1</kbd>.

![AgiNG Help](https://raw.githubusercontent.com/davep/aging/refs/heads/main/.images/aging-help-screen.png)

Commands can also be discovered via the command palette
(<kbd>ctrl</kbd>+<kbd>p</kbd>):

![The command palette](https://raw.githubusercontent.com/davep/aging/refs/heads/main/.images/aging-command-palette.png)

## Features

- Manage a directory of all of your Norton Guide files.
- Read Norton Guide files (obviously!).
- Clipboard support (copy text or copy source).
- A command palette to make it easy to discover commands and their keys.
- A rich help screen to make it easy to discover commands and their keys.
- [More as time goes on](https://github.com/davep/aging/issues?q=is%3Aissue+is%3Aopen+label%3ATODO).

## File locations

AgiNG stores files in a `aging` 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 AgiNG you will need to
remove those directories too.

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

- `~/.config/aging/configuration.json` -- The configuration file.
- `~/.local/share/aging/*.json` -- 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/aging/issues) or [start a
discussion](https://github.com/davep/aging/discussions).

## TODO

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

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