Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-03-17 05:00:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add development section to README

Browse source
This commit is contained in:
Thomas Zahner 2024-12-19 18:45:01 +01:00
parent 896ed837e6
commit 928b8bbe89
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -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