summaryrefslogtreecommitdiffstats
path: root/README.md
AgeCommit message (Collapse)Author
2022-10-18Update READMEs for new MSRV.Nora Widdecke
2022-09-06Document MSRV policy.Nora Widdecke
2022-07-01docs: Update dependencies list in README.Wiktor Kwapisiewicz
- Remove unused dependencies: capnproto and sqlite. - Restructure Windows section to highlight that the CNG backend is recommended on Windows. - Fix MSYS2 instructions to use `pacman` instead of `pacboy`. - Add mention of 32-bit build on Windows. - Remove Brew instructions that apparently are no longer needed in latest versions of Brew. - Test all variants. Windows and MacOS were tested in VMs and *nix distributions were tested in respective Docker containers. One issue worth mentioning that the NixOS script had to be run on version 2.3.16 as their later images seem to suffer from the regression of issue #137982 [0] (tested thanks to @puzzlewolf). - Fix #673 as now the minimal set is valid for both the openpgp crate and others (there are no additional dependencies). The only exception is the OpenSSL package required on Debian and Fedora. This has been explicitly clarified in the `Notes` section. - Fix #785. [0]: https://github.com/NixOS/nixpkgs/issues/137982
2022-02-02doc: Update IRC network used by Sequoia PGP.Wiktor Kwapisiewicz
2022-01-17readme: Remove ffi and python bindings.Nora Widdecke
Closes #799
2022-01-17docker: Mention in README.md.Nora Widdecke
2021-12-16Readme: Fix libclang reference in shell.nix.Nora Widdecke
- pkgs.llvmPackages.libclang has been split up into multiple outputs, we need .lib. - Closes #791.
2021-11-29Move MSRV to 1.56.1Nora Widdecke
- Rust 1.56.0 is affected by CVE-2021-42574, which is addressed in 1.56.1.
2021-10-18Relicense to LGPL 2.0 or later.Neal H. Walfield
- Change Sequoia's license from GPL 2.0 or later to LGPL 2.0 or later as unanimously decided on October 18, 2021 by: - Christof Wahl <cw@pep.security> (pEp security CEO) - Heiko Schaefer <heiko.schaefer@posteo.de> (pEp Foundation employee, Sequoia developer) - Justus Winter <justus@sequoia-pgp.org> (pEp Foundation employee, Sequoia Founder) - Neal H. Walfield <neal@pep.foundation> (pEp Foundation employee, Sequoia Founder) - Patrick Meier <pm@pep.security> (pEp security Chief Product and Service Officer) - Rudolf Bohli <rb@pep.security> (pEp security Chairman of the Board) - Volker Birk <vb@pep.security> (pEp security Founder, pEp Foundation Council)
2021-08-27ffi, readme: Remove mention of sequoia_core.Nora Widdecke
2021-07-09Link to sqv repository.Nora Widdecke
2021-07-09docker: Remove sqv.Nora Widdecke
2021-07-08Update reference to sq.Nora Widdecke
2021-04-22make: Hide Makefile to avoid confusion.Jonas Bernoulli
- Those make targets that are useful to users are just wrappers around the respective cargo commands, which means that they are not really necessary. The additional targets are primarily of use to Sequoia developers, which also means that they are not very useful to users. - That did not keep us from prominently advertising the use of make as a recommended installation mechanism, and that in turn contributed to some false expectations and confusion. - For example, a packager used the Makefile because they thought that that is what we would like them to do. Some users found it surprising that "sudo make install" ended up running the target "build-release" even though they had already build using "build". - People who want to keep using make without every time having to specify the name of the hidden Makefile can do so by creating a symbolic link.
2021-04-22doc: Add instructions on building and running sqv.Wiktor Kwapisiewicz
2021-04-22doc: Add instructions on using Docker to build sq.Wiktor Kwapisiewicz
- This shows how to use Docker to build both sq and sqv. - Attached example show how to use the image to do basic operations using sq container.
2021-04-12doc: Add section on building on macOS using Brew.Wiktor Kwapisiewicz
- Combine MRs !1054 and !1041. - Remove mention of XCode CLI tools as they are installed when installing Brew. - Use rust instead of rustup-init as this immediately makes cargo and other tools available on command line. - Remove pkg-config as it is a dependency of rust. - Remove coreutils as they are available through XCode CLI tools. - Add instruction on setting the environment variable as this seems to be a minor issue at least on Catalina. Closes !1054 and !1041. Co-authored-by: Alex R <argit@amhelm.com> Co-authored-by: Christian Ribeaud <chri@ribeaud.ch>
2021-04-12readme: Improve Debian instructions.Nora Widdecke
- Use the generic package name for libclang. - Mention rustup as fallback for buster.
2021-04-08Update MSRV to 1.48.0Nora Widdecke
- Update our MSRV to the one used in Debian bullseye, 1.48.0.
2021-03-04Use oxalica overlay in NixOS instructions.Nora Widdecke
2021-03-03Add NixOS instructions to readme.Nora Widdecke
- Closes #685
2021-02-20readme: List python dependency pip.Nora Widdecke
- setuptools 52.0.0, which is not in Debian bullseye, requires pip. Thus, transitively, we do to.
2020-12-09Add our bug tracker and security contact.Justus Winter
2020-12-09Fix address of mailing list.Justus Winter
2020-12-04Fix toml fragment to use Sequoia, cosmetic improvements.Justus Winter
2020-11-13Add build dependency.Justus Winter
2020-10-26Don't specify openpgp crate version number in README.md examplesIgor Matuszewski
2020-10-26Add an example on how to surface Sequoia backends for consumersIgor Matuszewski
2020-10-26Address review comments in README.mdIgor Matuszewski
2020-10-26Mention Cargo features and how to build with CNG in README.mdIgor Matuszewski
2020-10-14sq: Rename module to 'sequoia-sq'.Justus Winter
2020-10-14doc: Add required BSD packages to README.Wiktor Kwapisiewicz
2020-10-06Update README.md for MSRV 1.46.Nora Widdecke
- Fixes #557. - Use "1.46" in both READMEs.
2020-10-01doc: Unindent lines in code blocks.Wiktor Kwapisiewicz
The markup was messed up in commit 3731a890d. This change removed unneeded spaces in front of the code.
2020-07-31Update README.md.Justus Winter
2020-05-25Fix the required nettle version in README.md.Justus Winter
- Fixes #512.
2020-04-30Extend READMEGerhard Bräunlich
2020-03-30docs: Add build instructions for WindowsIgor Matuszewski
2019-12-03Add instructions for Fedora in README.md.David Sastre Medina
2019-11-05Fix license in README.md.Justus Winter
- Fixes 4f5699ef4ad8f84147edfa4785ed26d27c64d380.
2019-10-02Add note about disabling Python bindings.Wesley Moore
2019-08-20Update rust port nameJann Röder
2019-08-20Add coreutils to required packages on Mac OSJann Röder
- Fixes #329.
2019-07-08Update Debian build instructions now that Buster is released.Justus Winter
2019-06-26Bump the required rustc version to 1.34.Justus Winter
2019-05-08Improve build instructions.Justus Winter
2019-04-24Document the fact that we need Rust 1.32 by now.Justus Winter
2019-03-25Improve README.Justus Winter
2019-01-25Update build instructions in README.Neal H. Walfield
- We need at least version 1.31.0 of rustc. - Prefix commands that require root with sudo.
2019-01-11Add missing Python build dependencies.Justus Winter