diff --git a/docpages/building/freebsd.md b/docpages/building/freebsd.md index 8ba751a274..618ba787a1 100644 --- a/docpages/building/freebsd.md +++ b/docpages/building/freebsd.md @@ -3,6 +3,7 @@ \note This page assumes you are the root user. If you are not, start the package install commands with `sudo`, along with `make install`. You will need `sudo` installed if you are not the root user. ## 1. Toolchain + Since the project uses `CMake`, you'll need to install it! If you don't have it, you can do the following: ```bash @@ -10,6 +11,7 @@ pkg install cmake ``` ## 2. Install Voice Dependencies (Optional) + If you wish to use voice support, you'll need to install opus and libsodium: First, you need to install opus. @@ -34,14 +36,15 @@ cmake --build ./build -j8 Replace the number after `-j` with a number suitable for your setup, usually the same as the number of cores on your machine. `cmake` will fetch any dependencies that are required for you and ensure they are compiled alongside the library. -## 4. Install globally +## 4. Install Globally ```bash cd build make install ``` -## 5. Installation to a different directory (Optional) +## 5. Installation to a D0ifferent Directory (Optional) + If you want to install the library, its dependencies and header files to a different directory, specify this directory when running `cmake`: ```bash @@ -50,7 +53,8 @@ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install Then once the build is complete, run `sudo make install` to install to the location you specified. -## 6. Using the library +## 6. Using the Library + Once installed, you can make use of the library in standalone programs simply by including it and linking to it: ```bash @@ -59,12 +63,12 @@ clang++ -std=c++17 -L/usr/local/lib -I/usr/local/include -ldpp bot.cpp -o dppbot The important flags in this command-line are: - * `-std=c++17` - Required to compile the headers - * `-L/usr/local/lib` - Required to tell the linker where libdpp is located. - * `-I/usr/local/include` - Required to tell the linker where dpp headers are located. - * `-ldpp` - Link to `libdpp.so`. - * `bot.cpp` - Your source code. - * `-o dppbot` - The name of the executable to make. +* `-std=c++17` - Required to compile the headers +* `-L/usr/local/lib` - Required to tell the linker where libdpp is located. +* `-I/usr/local/include` - Required to tell the linker where dpp headers are located. +* `-ldpp` - Link to `libdpp.so`. +* `bot.cpp` - Your source code. +* `-o dppbot` - The name of the executable to make. \include{doc} install_prebuilt_footer.dox diff --git a/docpages/building/openbsd.md b/docpages/building/openbsd.md index 306b283a76..a289d75f13 100644 --- a/docpages/building/openbsd.md +++ b/docpages/building/openbsd.md @@ -3,6 +3,7 @@ \note This page assumes you are the root user. If you are not, start the package install commands with `doas`, along with `make install`. ## 1. Toolchain + Since the project uses `CMake`, you'll need to install it! If you don't have it, you can do the following: ```bash @@ -10,6 +11,7 @@ pkg_add cmake ``` ## 2. Install Voice Dependencies (Optional) + If you wish to use voice support, you'll need to do the following: ```bash @@ -25,13 +27,13 @@ cmake --build ./build -j8 Replace the number after `-j` with a number suitable for your setup, usually the same as the number of cores on your machine. `cmake` will fetch any dependencies that are required for you and ensure they are compiled alongside the library. -## 4. Install globally +## 4. Install Globally ```bash cd build; make install ``` -## 5. Installation to a different directory +## 5. Installation to a Different Directory If you want to install the library, its dependencies and header files to a different directory, specify this directory when running `cmake`: @@ -41,7 +43,8 @@ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install Then once the build is complete, run `make install` to install to the location you specified. -## 6. Using the library +## 6. Using the Library + Once installed to the `/usr/local` directory, you can make use of the library in CMake, without linking to a folder! You can't use this with `clang++`, nor `g++`, as OpenBSD seems to be broken on this end, so your only option from here is to use CMake. This isn't a bad thing, as we recommend people to use CMake anyways! **Have fun!**