Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

The dictionary and toolkit for the **grid script**: how humans write down what Ross 128 b sends, in InterImm's *The Contact Era*.

**Docs:** https://interimm.github.io/glyph-cli/
[![PyPI](https://img.shields.io/pypi/v/glyph-cli)](https://pypi.org/project/glyph-cli/)
[![Python](https://img.shields.io/pypi/pyversions/glyph-cli)](https://pypi.org/project/glyph-cli/)
[![CI](https://github.com/InterImm/glyph-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/InterImm/glyph-cli/actions/workflows/ci.yml)
[![Docs](https://github.com/InterImm/glyph-cli/actions/workflows/docs.yml/badge.svg)](https://interimm.github.io/glyph-cli/)

**Docs:** https://interimm.github.io/glyph-cli/ 路 **PyPI:** https://pypi.org/project/glyph-cli/

```sh
uvx --from glyph-cli glyph show BODY.OTHER STAR.TIME COUNT.137
Expand All @@ -19,11 +24,14 @@ uvx --from glyph-cli glyph show BODY.OTHER STAR.TIME COUNT.137

## Install

`glyph` is on [PyPI](https://pypi.org/project/glyph-cli/) as `glyph-cli`:

```sh
uv tool install glyph-cli # or: pipx install glyph-cli, or: pip install glyph-cli
glyph --version
```

Python 3.10 or newer, no other dependencies.
Upgrade with `uv tool upgrade glyph-cli` (or `pipx upgrade glyph-cli`, `pip install -U glyph-cli`). Python 3.10 or newer, no other dependencies.

## Use

Expand Down
28 changes: 25 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Install

`glyph` needs Python 3.10 or newer and has no other dependencies.
`glyph` is published on [PyPI](https://pypi.org/project/glyph-cli/) as **`glyph-cli`** (the command it installs is `glyph`). It needs Python 3.10 or newer and has no other dependencies.

=== "uv"

Expand All @@ -22,14 +22,36 @@
pip install glyph-cli
```

The latest code on `main` installs with `uv tool install git+https://github.com/InterImm/glyph-cli`.

Check it works:

```sh
glyph --version
```

To get a newer release later:

=== "uv"

```sh
uv tool upgrade glyph-cli
```

=== "pipx"

```sh
pipx upgrade glyph-cli
```

=== "pip"

```sh
pip install -U glyph-cli
```

!!! tip "Unreleased changes"
PyPI has the latest release. To try what is on `main` before it is released, install from GitHub instead:
`uv tool install git+https://github.com/InterImm/glyph-cli`.

## Look at the parts

Everything is built from 16 parts, each a 3脳3 shape.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ uvx --from glyph-cli glyph show BODY.OTHER STAR.TIME COUNT.137
COUNT.137: 137
```

Then follow [Getting started](getting-started.md).
`uvx` fetches [`glyph-cli` from PyPI](https://pypi.org/project/glyph-cli/) and runs it. To keep the `glyph` command, install it with `uv tool install glyph-cli` (or `pipx install glyph-cli`, or `pip install glyph-cli`), then follow [Getting started](getting-started.md).

## What it does

Expand Down
4 changes: 4 additions & 0 deletions zensical.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ toggle.name = "Switch to dark mode"
icon = "fontawesome/brands/github"
link = "https://github.com/InterImm/glyph-cli"

[[project.extra.social]]
icon = "fontawesome/brands/python"
link = "https://pypi.org/project/glyph-cli/"

[project.markdown_extensions]
admonition = {}
attr_list = {}
Expand Down
Loading