about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2022-11-20 00:46:38 +0100
committerbptato <nincsnevem662@gmail.com>2022-11-20 00:46:38 +0100
commit06fbb9bc967e11151fdd1311437248cf9bc25706 (patch)
treeabc95f94e3cce362ca27f466486b8eba19546272
parent0cfe40914404aea4df691cfb9a1f8486381268ed (diff)
downloadchawan-06fbb9bc967e11151fdd1311437248cf9bc25706.tar.gz
Update readme
-rw-r--r--readme.md41
1 files changed, 23 insertions, 18 deletions
diff --git a/readme.md b/readme.md
index 27c8cf94..5fb93cb2 100644
--- a/readme.md
+++ b/readme.md
@@ -5,12 +5,16 @@
 A terminal web browser. It displays websites in your terminal and allows you to
 navigate on them.
 
-It includes its own parsers, pager, and layout engine.
+It also functions as a pager, similarly to w3m.
 
 ## Compiling
 
 1. Install the nim compiler.
-2. Use one of the following:
+2. Install the following dependencies:
+	- curl
+	- quickjs
+	- notcurses
+3. Use one of the following:
 	- `make release` - normal release build
 	- `make` - debug build
 
@@ -20,27 +24,26 @@ Currently implemented features are:
 
 * a unicode, double-width capable pager
 * a CSS-capable layout engine
-* forms
+* forms, tables
+* incremental loading of plain text streams
+* JavaScript based navigation
 
 **Planned** features, roughly in order of importance:
 
+* JavaScript in html documents
+* non-unicode charsets (they currently crash the browser)
 * partial re-rendering of page layout
 * unicode normalization
-* non-unicode charsets (they currently crash the browser)
 * fast streams (aka pipelines; use library?)
 * standard-compliant support for remote resources
-* incremental page loading (to function as a proper pager)
-* table
 * iframe
 * ruby
-* separate threads for io, fetching resources and rendering pages
 * cookies
 * external viewers (for audio, video, image, etc)
 * image (sixel & kitty?)
 * markdown (built-in parser)
 * color contrast correction
 * terminal color mode
-* JavaScript
 * config editor
 * user stylesheet editor
 * SOCKS proxy
@@ -52,20 +55,22 @@ Currently implemented features are:
 * gopher?
 * gemini??
 
-## Motivation
+## Configuration
+
+See [doc/config.md](doc/config.md).
+
+## FAQ
+
+### Why did you write this?
 
 I've found other terminal web browsers insufficient for my needs, so I thought
 it'd be a fun excercise to write one by myself, for myself.
 
 The end result will of course not support nearly as many websites as Firefox or
 Chromium, but I'd like it to be at least somewhat more functional on the
-"modern web" than w3m or lynx.
-
-In one way this is supposed to be a spiritual successor of w3m, with lots of
-features but a completely different architecture. Meaning this browser should
-be able to function as a replacement of w3m, just better. (I am still quite far
-from reaching that goal however.)
+"modern" web than w3m or lynx.
 
-## Configuration
-
-See [doc/config.md](doc/config.md).
+In one way this is supposed to be a spiritual successor of w3m, with a roughly
+similar set of features but on a completely different architecture. Meaning
+this browser should be able to function as a replacement of w3m, just "better"
+(YMMV).