Repos / mcross / 6e46534e02
commit 6e46534e02c089860c7dbb074a5feeb905776f88
Author: Bùi Thành Nhân <hi@imnhan.com>
Date: Fri May 15 20:13:53 2020 +0700
update readme
diff --git a/README.md b/README.md
index 77cfae4..918ad98 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,6 @@
McRoss is a WIP [gemini://](https://gemini.circumlunar.space/) browser
written in python and tkinter.
-It's developed against gemini://gemini.circumlunar.space/ because apparently
-that's the only server with a valid, CA-approved TLS cert.
-
It currently looks like this:
@@ -19,12 +16,30 @@ # Installation
mcross
```
-# Deps
+Better distribution methods to be explored later.
+Maybe it's finally time to try nuitka?
+
+# Development
+
+Deps:
- python3.7+
- idlelib (it's supposed to be in the standard lib but Ubuntu for example
splits it into a separate package)
+To get started:
+
+```sh
+pyenv install 3.7.7
+pyenv virtualenv 3.7.7 mcross
+pyenv activate
+poetry install
+mcross
+
+# to publish, first bump version in pyproject.toml then
+poetry publish --build
+```
+
# Feature checklist
- [x] back-forward buttons
@@ -32,7 +47,22 @@ # Feature checklist
- [ ] more visual indicators - maybe a status bar at the bottom
- [ ] parse gemini's advanced line types
- [ ] configurable document styling
-- [ ] configurable TLS
+- [ ] configurable TLS to accomodate self-signed sites?
+
+Long term high-level goals:
+
+- Should be easy for end users to install. If the word `rustup` exists in the
+ installation guide for your G U I application then I'm sorry it's not
+ software made for people to _use_.
+- Should be 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.
+- The viewport should be rendered so that its content can be copied and still
+ remain equivalent, valid gemini markup. Abolish the content creator vs
+ consoomer divide!
+- Lightweight, in terms of both disk space & memory/cpu usage. It's completely
+ unoptimized at the moment but tkinter and zero-dependency python gives us a
+ fairly good starting point imo.
# Server bugs/surprises