about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2024-07-29 19:15:36 +0200
committerbptato <nincsnevem662@gmail.com>2024-07-29 23:24:33 +0200
commitfd742d0243d80d0fc929ef88e4c95d713304d300 (patch)
treecbd96fa9141453ebd73bea41a20a236efbf84edd /README.md
parent1e719997eda085e998d38a90134f26489e50188e (diff)
downloadchawan-fd742d0243d80d0fc929ef88e4c95d713304d300.tar.gz
Update docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index d9ba5e75..cfff17da 100644
--- a/README.md
+++ b/README.md
@@ -54,10 +54,11 @@ Currently implemented features are:
 * user-programmable keybindings (defaults are vi(m)-like)
 * basic JavaScript support in documents (disabled by default for security
   reasons)
-* supports several protocols: HTTP(S), FTP, Gopher, Gemini, Finger, etc.
-* can [load](doc/localcgi.md) [user-defined](doc/urimethodmap.md)
-  [protocols](doc/protocols.md)/[file formats](doc/mailcap.md)
-* built-in markdown viewer, man page viewer
+* supports several [protocols](doc/protocols.md): HTTP(S), FTP, Gopher, Gemini,
+  Finger, etc.
+* can load user-defined [protocols](doc/urimethodmap.md) and
+  [file formats](doc/mailcap.md)
+* markdown viewer, man page viewer
 * WIP sixel/kitty image support (still somewhat limited; progress tracked at
   <https://todo.sr.ht/~bptato/chawan/13>)
 * mouse support
@@ -79,6 +80,11 @@ Currently implemented features are:
 * protocols: [doc/protocols.md](doc/protocols.md)
 * troubleshooting: [doc/troubleshooting.md](doc/troubleshooting.md)
 
+If you're interested in modifying the code:
+
+* architecture: [doc/architecture.md](doc/architecture.md)
+* style guide, debugging tips, etc.: [doc/hacking.md](doc/hacking.md)
+
 ## Neighbors
 
 Many other text-based web browsers exist. Here's some recommendations if you
@@ -86,7 +92,7 @@ want to try more established ones:
 
 * [w3m](https://github.com/tats/w3m) - A text-mode browser, extensible using
   local-cgi. Also has inline image display and very good table support.
-  Inspired many features of Chawan.
+  Main source of inspiration for Chawan.
 * [elinks](https://github.com/rkd77/elinks) - Has CSS and JavaScript support,
   and incremental rendering (it's pretty fast.)
 * [lynx](https://lynx.invisible-island.net/) - "THE text-based web browser."