Commit Graph

13 Commits

Author SHA1 Message Date
Robin Krahl
686b8bb1b0
Add --locked flag to cargo install invocation
This patch adds the --locked flag to the cargo install invocation in
INSTALL.md as this makes sure that the users ends up with tested and
working dependency versions.
2021-06-06 13:59:59 +02:00
Robin Krahl
2c1b91462e
Release v0.4.1
This patch release fixes an issue with the pager configuration.
2020-10-11 22:41:05 +02:00
Robin Krahl
56cb98e867
Release v0.4.0
This minor release introduces a new interactive viewer, tui.  It also
adds syntax highlighting for code in the documentation and support for
Rust 1.47.0.
2020-10-09 12:16:01 +02:00
Robin Krahl
8db34e33b2
Use termion backend for cursive
With this patch, we replace cursive’s default ncurses backend with the
termion backend.  This has multiple reasons:
- The ncurses backend has safety issues, see [0].
- ncurses requires a pre-installed library and a C compiler, introducing
  additional build dependencies.  Termion is implemented in Rust only.
- ncurses does not work on Windows, while termion works in all terminals
  that support ANSI escape codes.

Per default, the termion backend does not buffer the output which may
cause flickering [1].  Therefore, we also use the
cursive_buffered_backend that buffers the output and fixes the
flickering problem.

[0] https://github.com/gyscos/cursive/issues/488
[1] https://github.com/gyscos/cursive/issues/142
2020-10-08 10:30:17 +02:00
Robin Krahl
e222a1f443
Add TUI viewer using cursive
This patch adds a new viewer, tui, that provides an interactive
interface using cursive.  This viewer makes it possible to follow links
to other documentation items and to open external links in a web
browser.
2020-10-06 19:19:13 +02:00
Robin Krahl
642bec6687
Release v0.3.0
This minor release adds support for Rust 1.46.0 and significantly
improves the test suite.
2020-09-11 21:58:29 +02:00
Robin Krahl
76845785ee
Release v0.2.0
This minor release adds support for syntax highlighting of code snippets
and for configuration files.
2020-08-11 10:31:03 +02:00
Robin Krahl
3affe94234
Update installation instructions
This patch updates the installation instructions with information on the
AUR packgage and on the tarball downloads.
2020-08-11 09:59:43 +02:00
Robin Krahl
44028e228a
Release v0.1.3
This patch release adds support for documentation generated with Rust
1.45.0 and fixes some minor bugs in the documentation parser.  It also
adds the documentation downloaded using rustup to the default sources.
2020-07-28 14:59:12 +02:00
Robin Krahl
4d7c7d4eab
Release v0.1.2
This patch release adds basic logging output and a new `-e`/`--examples`
option to extract only the examples from the documentation.  It also
fixes a bug when displaying the documentation for a function.
2020-07-25 13:29:14 +02:00
Robin Krahl
af1b81dd57
Release v0.1.1
This patch release fixes some minor issues with the documentation
displayed on crates.io.
2020-07-24 14:26:25 +02:00
Robin Krahl
0a1dd0838e
Update installation instructions
This patch adds information about installing from crates.io and suggests
checking out the latest release when installing from source.
2020-07-24 13:45:23 +02:00
Robin Krahl
1128919f1f
Add installation and contributing information
This patch extends the README.md file and adds the INSTALL.md and
CONTRIBUTING.md files with more detailed information.
2020-07-20 01:42:30 +02:00