summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-07-31 11:58:45 +0200
committerJustus Winter <justus@sequoia-pgp.org>2020-07-31 17:58:01 +0200
commit70aa15871d413300f699d86d4392ea52c5d0e509 (patch)
tree8956f92fb2351a56e862ce3ce80b9a682333f782
parentb9fa90f13655cd7e85522be91e91456077884427 (diff)
Update README.md.
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 242e1ca1..34cbb0b8 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ Please note that as of this writing the high-level API is very
incomplete.
Command line interface
---------------
+----------------------
Sequoia includes a simple frontend `sq` (crate [tool](./tool)) that
can be used to experiment with Sequoia and OpenPGP. It is also an
@@ -75,7 +75,7 @@ any later version. See the file [LICENSE.txt](LICENSE.txt) or visit
https://www.gnu.org/licenses/gpl-2.0.html for details.
Using Sequoia
-================
+=============
If you want to use Sequoia from Rust, you can simply register the
dependency in your `Cargo.toml` file as with any other project. Note
@@ -91,11 +91,13 @@ Building Sequoia
Using cargo
-----------
-To build Sequoia, simply execute `cargo build [--release]`.
-To build `sq`, run `cargo build [--release] -p sequoia-tool`.
+To build all Sequoia components, simply execute `cargo build
+[--release] --all`. Individual components may be built independently,
+e.g. to build `sq`, run `cargo build [--release] -p sequoia-tool`, or
+build `sequoia-openpgp-ffi` to build a shared object with the C API.
Using the Makefile
------------
+------------------
We also consider the needs of packagers in times
where distribution support for packaging Rust projects is not yet
@@ -108,6 +110,10 @@ use `make install`. The latter target honors `PREFIX` and `DESTDIR`.
Finally, to return your source tree to its pristine state, run `make
clean`.
+You can specify subdirectories to build individual modules, e.g. use
+`make -Copenpgp-ffi install` to only install the shared object with
+the C API.
+
**Note:** By default the Python FFI bindings are also built. To skip
these add `PYTHON=disable` to all `make` invocations. E.g. `make
PYTHON=disable`.