From 928b8bbe892b3344b18cb2a8e37ee731b32a1981 Mon Sep 17 00:00:00 2001 From: Thomas Zahner Date: Thu, 19 Dec 2024 18:45:01 +0100 Subject: [PATCH] Add development section to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d2b6a2d..90cbbf4 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ Available as a command-line utility, a library and a [GitHub Action](https://git ## Table of Contents - [Installation](#installation) +- [Development](#development) - [Features](#features) - [Commandline usage](#commandline-usage) - [Library usage](#library-usage) @@ -148,6 +149,12 @@ Lychee supports several feature flags: By default, `native-tls` and `email-check` are enabled. +## Development + +After [installing Rust](https://www.rust-lang.org/tools/install) use [Cargo](https://doc.rust-lang.org/cargo/) for building and testing. +On Linux the OpenSSL package [is required](https://github.com/seanmonstar/reqwest?tab=readme-ov-file#requirements) to compile `reqwest`, a dependendy of lychee. +For Nix we provide a flake so you can use `nix develop` and `nix build`. + ## Features This comparison is made on a best-effort basis. Please create a PR to fix