diff options
| author | bptato <nincsnevem662@gmail.com> | 2024-04-02 17:00:35 +0200 |
|---|---|---|
| committer | bptato <nincsnevem662@gmail.com> | 2024-04-02 17:00:35 +0200 |
| commit | 9177dde424cdc50897c47826a8153342d724beb0 (patch) | |
| tree | b0900885eadc722c42155a0c608a83c88f876e92 | |
| parent | 76dd27fdf66195455af53cb7d7f090055467c9bc (diff) | |
| download | chawan-9177dde424cdc50897c47826a8153342d724beb0.tar.gz | |
Update readme
| -rw-r--r-- | README.md | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/README.md b/README.md index 7a2f9ee3..46705774 100644 --- a/README.md +++ b/README.md @@ -19,21 +19,24 @@ supported yet.) 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.0. Older versions will - not work. (You can check your Nim compiler's version using `nim -v`.) + * Please use 1.6.14 or newer, ideally 2.0.2. Versions older than 1.6.14 + will not work. (You can check your Nim compiler's version using + `nim -v`.) 3. Install the following dependencies: * libcurl: <https://curl.se/libcurl/> * zlib: <https://zlib.net/> - * pkg-config, pkgconf, or similar (must be found as "pkg-config" - in your `$PATH`) - * If you are using a system where the default make program is not - GNU make (e.g. BSD), install gmake and use that in the following - steps. + * pkg-config, pkgconf, or similar (must be found as "pkg-config" in your + `$PATH`) + * If you are using a system where the default make program is not GNU + make (e.g. BSD), install gmake and use that in the following steps. + * Optional: a termcap library; e.g. ncurses comes with one. + * TLDR for Debian: + `apt install libcurl4-openssl-dev zlib1g-dev pkg-config make ncurses-base` 4. Download parts of Chawan found in other repositories: `make submodule` 5. Run `make`. (By default, this will build the whole project in release mode; for details, see [doc/build.md](doc/build.md).) -6. If you want manpages, run `make manpage`. (This requires pandoc to be - installed.) +6. If you want manpages, run `make manpage`. (This requires + [pandoc](https://pandoc.org).) 7. Finally, install using `make install` (e.g. `sudo make install`). Then, try: @@ -65,6 +68,7 @@ Currently implemented features are: * supports several protocols: HTTP(S), FTP, Gopher, Gemini, Finger, etc. * can load user-defined protocols/file formats using [local CGI](doc/localcgi.md), [urimethodmap](doc/urimethodmap.md) and [mailcap](doc/mailcap.md) +* markdown viewer * man page viewer (like w3mman) * mouse support |