diff options
| author | bptato <nincsnevem662@gmail.com> | 2024-06-02 18:54:24 +0200 |
|---|---|---|
| committer | bptato <nincsnevem662@gmail.com> | 2024-06-02 19:17:14 +0200 |
| commit | e1a03329f113a30c092d4f1dcd8d99f6ed4ec335 (patch) | |
| tree | 7b9ac19a96a535c157938687cc017756635e431f | |
| parent | 32b2736d92b3f94343c91e86ad9dc67ec2e453b7 (diff) | |
| download | chawan-e1a03329f113a30c092d4f1dcd8d99f6ed4ec335.tar.gz | |
Update docs
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | doc/architecture.md | 13 |
2 files changed, 5 insertions, 12 deletions
diff --git a/README.md b/README.md index c1849f72..49769412 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ It can also be used as a terminal pager. Note: a POSIX-compliant operating system is required. -1. Clone the Chawan repository: +1. Clone the Chawan repository: `git clone https://git.sr.ht/~bptato/chawan && cd chawan` 2. Install the Nim compiler: <https://nim-lang.org/install.html> * Please use 1.6.14 or newer, ideally 2.0.4. Versions older than 1.6.14 @@ -33,7 +33,7 @@ Note: a POSIX-compliant operating system is required. * TL;DR for Debian: `apt install libcurl4-openssl-dev zlib1g-dev pkg-config make ncurses-base libseccomp-dev` 4. Download parts of Chawan found in other repositories: `make submodule` -5. Run `make`. +5. Run `make` (without arguments). 6. Install using `make install` (e.g. `sudo make install`). Then, try: diff --git a/doc/architecture.md b/doc/architecture.md index b3d2d6ec..afee484b 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -235,26 +235,19 @@ console.log(document.querySelector("html").canary); /* chirp */ ### JS in the pager -Currently this is very limited: keybindings can be assigned JavaScript functions -in the config, and then the pager executes those when the keybindings are -pressed. - -(This turns out to be a rather poor configuration system, so we have a plan to -improve it [here](https://todo.sr.ht/~bptato/chawan/6). Just need to implement -it some time...) +Keybindings can be assigned JavaScript functions in the config, and then the +pager executes those when the keybindings are pressed. Also, contents of the start.startup-script option are executed at startup. This is used when `cha` is called with the `-r` flag. -There *is* an API, but it's somewhat underdocumented. Web APIs are exposed to +There *is* an API, described at [api.md](api.md). Web APIs are exposed to pager too, but you cannot operate on the DOMs themselves from the pager, unless you create one yourself with DOMParser.parseFromString. [config.md](config.md) describes all commands that are used in the default config. -A more complete description of the API can be found in [api.md](api.md). - ### JS in the buffer The DOM is implemented through the same wrappers as those in pager. (Obviously, |