Skip to content

docs: fix cargo c links in README #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 12, 2024
Merged

docs: fix cargo c links in README #500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ to provide the cryptographic primitives.

To build rustls-ffi as a static or shared library you'll need to [install the
Rust toolchain](https://rustup.rs/) (version 1.71 or above) as well as
[cargo c](https://github.com/lu-zero/cargo-c).
[cargo-c].

The [cargo-c] tool can be installed from
[your package manager](https://github.com/lu-zero/cargo-c?tab=readme-ov-file#availability)
Expand All @@ -33,6 +33,8 @@ If you plan to build the `client` and `server` [C examples](#example-application
you will also need `cmake` and a C compiler (`gcc` and `clang` should both work,
as well as MSVC on Windows).

[cargo-c]: https://github.com/lu-zero/cargo-c

## Building and Installing

```bash
Expand All @@ -42,7 +44,7 @@ sudo cargo capi install --release
```

If you receive a message like "error: no such command capi" you need to install
[cargo c] from your package manager, or using `cargo install cargo-c`.
[cargo-c] from your package manager, or using `cargo install cargo-c`.

To change where the library is installed, use `--prefix` like:

Expand Down
Loading