Updated README.md to include getting deps and linking headers

This commit is contained in:
David Allen 2024-06-09 00:07:14 -06:00
parent 13da8c03f2
commit 846bc4932f
No known key found for this signature in database
GPG key ID: 1D2A29322FBB6FCB

View file

@ -118,19 +118,34 @@ The project uses the CMake or Meson build system and has been tested with GCC an
* fmt (may be removed later in favor of C++20 std::format) * fmt (may be removed later in favor of C++20 std::format)
* SQLite 3 * SQLite 3 and SQLite C++ wrapper
* cxxopts
* doctest (optional; for tests, but still WIP) * doctest (optional; for tests, but still WIP)
* Doxygen (optional; to generate API docs) * Doxygen (optional; to generate API docs)
Arch Linux users can simply install required libs through pacman: Arch Linux users can simply install required libs through `pacman` and/or `yay`:
```bash ```bash
pacman -S base-devel fmt sqlite3 rapidjson cmake libzip curl pacman -S base-devel fmt sqlite rapidjson cmake libzip curl catch2 cxxopts
yay -S sqlitecpp curlcpp
``` ```
After installing all necessary dependencies, build the project:: After installing the packages, clone the submodules and link the headers:
```bash
git submodule add https://github.com/p-ranav/argparse modules/argparse
git submodule add https://github.com/p-ranav/tabulate modules/tabulate
git submodule add https://github.com/p-ranav/indicators modules/indicators
ln -s ../modules/argparse/include/argparse include/argparse
ln -s ../modules/tabulate/include/tabulate include/tabulate
ln -s ../modules/indicators/include/indicators include/indicators
```
And then build the project:
```bash ```bash
# Start by cloning the repo, then... # Start by cloning the repo, then...