Skip to content

Commit

Permalink
docs: corrected some grammar
Browse files Browse the repository at this point in the history
Co-authored-by: Jakub 'Eremiell' Marek <[email protected]>
  • Loading branch information
Jaskowicz1 and Eremiell committed Oct 3, 2023
1 parent 8672cc4 commit 97e971e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
22 changes: 13 additions & 9 deletions docpages/building/freebsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
\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
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.
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down
9 changes: 6 additions & 3 deletions docpages/building/openbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
\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
pkg_add cmake
```

## 2. Install Voice Dependencies (Optional)

If you wish to use voice support, you'll need to do the following:

```bash
Expand All @@ -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`:

Expand All @@ -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!**

0 comments on commit 97e971e

Please sign in to comment.