Commit Graph

9 Commits

Author SHA1 Message Date
Devan Carpenter
da9afcb242
update container examples in readme 2024-11-20 02:12:26 +00:00
Justus Winter
1f6e079947
Link to the new user documentation. 2024-09-03 17:16:31 +02:00
Justus Winter
50ded9a469
Improve build and installation instructions. 2024-01-19 14:13:14 +01:00
Justus Winter
f384e89cf3
Add documentation links to the README.md. 2024-01-10 17:52:47 +01:00
Justus Winter
0ea5ef9fad
Write assets like manual pages to a predictable location.
- Fixes #45.
2024-01-05 15:57:05 +01:00
Justus Winter
f81d6f09af
Use our custom manual page generator during build time.
- Previously, there were two ways of generating manual pages.
    We used to use the upstream clap_mangen crate, but decided to
    develop our own custom formatter.  However, we didn't quite switch
    to it, keeping the old mechanism in place and adding our new
    solution to sq, activated by a hidden environment variable.

  - This patch drops the upstream formatter, and uses the custom
    formatter during build time.  First, our custom code can be
    tweaked easily to suit our needs, and switching back to the
    upstream solution is easy enough should it better suit our needs.
    Second, generating manual pages at build time should help
    cross-building environments.
2024-01-05 13:56:32 +01:00
David Runge
3ea5afe4e3
Add instructions on man page creation to README
- Add instructions on how to build the `sq` executable and its shell
 completions.
- Add information on how to generate the man pages using the `SQ_MAN`
  environment variable.
- Disable printing of info about `clap_mangen` generated man pages,
  since they still lack features and are partially incorrect.
2023-06-12 16:14:50 +02:00
Neal H. Walfield
1492c0a6fe
Update README
- Remove section on how to generate the man pages.  They are now
    generated automatically.
2023-04-18 14:27:34 +02:00
Justus Winter
b89c172c1d
Reincarnation commit.
- This implementation has been moved from the Sequoia repository to
    its own repository.  To inspect the history, either look at the
    Sequoia repository, or graft it onto this repository like this:

      $ git remote add sequoia https://gitlab.com/sequoia-pgp/sequoia
      $ git fetch sequoia 82eb0d7b240d137141fc0aaaa3dff1685bb11864
      $ git replace --graft <THIS-COMMIT> 82eb0d7b240d137141fc0aaaa3dff1685bb11864
2023-02-21 12:43:43 +01:00