~fkfd/mcross

96bf9cf2c3b12e99ef71c07373e53a9bd322f2eb — Frederick Yin 3 years ago c590657 master
Restructure README

- prioritize features
- remove "TOFU not ready" statement
1 files changed, 39 insertions(+), 43 deletions(-)

M README.md
M README.md => README.md +39 -43
@@ 14,12 14,47 @@ It currently looks like this with my config file:

![](https://fkfd.me/static/mcross-0.6.0-preview.png)

Surfing plaintext and gemini content is already working well. The catch is it
currently doesn't support TOFU TLS verification. See feature checklist below
for more details.

See Nhân's [blog post][1] for the rationale behind this project.

# Feature checklist

- [x] back-forward buttons
- [x] handle redirects
- [x] non-blocking I/O using curio
- [x] more visual indicators: waiting cursor, status bar
- [x] parse gemini's advanced line types
- [x] render `text/*` mime types with correct charset
- [x] handle `binary/*` mime types
- [x] configurable document styling
- [ ] human-friendly distribution
- [x] TOFU TLS (right now it always accepts self-signed certs)
- [x] tabs
- [ ] i18n

## Easy for end users to install

> If the words `cargo build` exists in the installation guide for your G U I
> application then I'm sorry it's not software made for people to _use_. — Nhân

> I agree. — Frederick

## What-you-see-is-what-you-write

A rendered text/gemini viewport should preserve its original text content.
This way once you've read a gemini page on the browser, you already know how to
write one. No "View Source" necessary.

## Responsive & pleasant to use

The Castor browser doesn't have visual indicators at all, for example, when
clicking on a link it just appears to do nothing until the new page is
completely loaded. That is A Bad Thing (tm).

## Lightweight

In terms of both disk space & memory/cpu usage.
The python/tkinter combo already puts us at a pretty good starting point.

# Usage

Run `mcross -h` to get a full list of CLI arguments. The same arguments can


@@ 101,45 136,6 @@ If you're not familiar with the mailing list workflow, check out
also has useful plaintext setup tips for various email clients, though Nhân
doesn't necessarily agree with its "plaintext or nothing" stance.

# Feature checklist

- [x] back-forward buttons
- [x] handle redirects
- [x] non-blocking I/O using curio
- [x] more visual indicators: waiting cursor, status bar
- [x] parse gemini's advanced line types
- [x] render `text/*` mime types with correct charset
- [x] handle `binary/*` mime types
- [x] configurable document styling
- [ ] human-friendly distribution
- [x] TOFU TLS (right now it always accepts self-signed certs)
- [x] tabs
- [ ] i18n

## Easy for end users to install

> If the words `cargo build` exists in the installation guide for your G U I
> application then I'm sorry it's not software made for people to _use_. — Nhân

> I agree. — Frederick

## What-you-see-is-what-you-write

A rendered text/gemini viewport should preserve its original text content.
This way once you've read a gemini page on the browser, you already know how to
write one. No "View Source" necessary.

## Responsive & pleasant to use

The Castor browser doesn't have visual indicators at all, for example, when
clicking on a link it just appears to do nothing until the new page is
completely loaded. That is A Bad Thing (tm).

## Lightweight

In terms of both disk space & memory/cpu usage.
The python/tkinter combo already puts us at a pretty good starting point.

# Server bugs/surprises

## Forces gemini:// in request