Skip to content
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

documentation fixes #13

Merged
merged 2 commits into from
Feb 19, 2025
Merged

documentation fixes #13

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b40b321
fixed some typos, MD heading usage (to follow guidelines) and linux b…
Feb 18, 2025
02fbab8
maintainer requested PR changes
Feb 19, 2025
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
5 changes: 3 additions & 2 deletions BUILD-FreeBSD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
### FreeBSD 14.1
# FreeBSD 14.1

## Install Dependencies

#### Install Dependencies
```bash
# as root
pkg install bash getopt cmake ccmake ccache git ruby ruby32-gems rubygem-rake curl libevent onetbb
Expand Down
9 changes: 4 additions & 5 deletions BUILD-Windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Build with MSYS2 / mingw
# Build with MSYS2 / mingw

Download and install MSYS2 with all default settings
https://www.msys2.org/
Expand All @@ -25,17 +25,16 @@ and continue with main README...
## Running executables / loading shared libraries

By default this project builds with as many static libraries as
possible, but you still need to ensure the remaining dynbamic ones can
possible, but you still need to ensure the remaining dynamic ones can
be found. Note that `PATH` is sensibly configured within the MSYS2
environment, and executables should just run trivially there. But the
same will not necessarily be true in the Windows `cmd` console, or
when launching from File Explorer, etc.

To be able to run the programs in the build directory from the `cmd`
(windows shell) you need to put `C:\msys64\ucrt64\bin`into your `PATH`
(windows shell) you need to put `C:\msys64\ucrt64\bin` into your `PATH`
environment variable. You can do that in the usual place in the
Windows GUI.

Any problems and you can check what each program is loading with
Any problems and you can check what each program is loading with
`ldd program_name` from within the MSYS2 console.

17 changes: 9 additions & 8 deletions BUILD-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
### Recent Linux systems from the last 5 years
# Building on Linux

Explcitly tested on:
## Recent Linux systems from the last 5 years

Explicitly tested on:
Debian 11 & 12, Ubuntu 20.04LTS, 22.04LTS & 24.04LTS.

On rpm system, the package names may vary slightly. The only runtime
dependencies are libcurl and libevent (plus libtbb if you compile with
`-DHIBP_WITH_PSTL`.
`-DHIBP_WITH_PSTL`).

## Install Dependencies

#### Install Dependencies
```bash
sudo apt install build-essential cmake ninja-build ccache git libcurl4-openssl-dev libevent-dev ruby libtbb-dev
sudo apt install build-essential cmake curl ninja-build ccache git libcurl4-openssl-dev libevent-dev rubylibtbb-dev
git clone https://github.com/oschonrock/hibp.git
cd hibp
git submodule update --init --recursive
Expand All @@ -18,8 +21,6 @@ sudo gem install Mxx_ru # install ruby gem required for restinio dependency in
mxxruexternals # install those deps
cd ../..

# optional: for compilng with clang also:
# optional: for compiling with clang also:
sudo apt install clang gcc-14 g++-14 # need gcc-14 because clang tries to use its stdlibc++ version

```

Loading