Added instructions to use cxxopts with tipi to INSTALL (#325)

Yannic Staudt · GitHub
1 parent 4e208b95
Showing 5 changed files with 30 additions and 0 deletions
.tipi/deps
.tipi/opts
INSTALL
src/.tipi/deps
test/.tipiignore
+{ }
 \ No newline at end of file
@@ -21,3 +21,26 @@ To run the tests, you have to configure `cxxopts` with another flag:
    cmake -D CXXOPTS_BUILD_TESTS=On ${CXXOPTS_DIR}
    make
    make test
+
+== Using cxxopts in tipi.build projects ==
+
+`cxxopts` can be easily used in [tipi.build](https://tipi.build) projects simply by adding the following entry to your `.tipi/deps`:
+
+```json
+{
+  "jarro2783/cxxopts": { "@": "v3.0.0" }
+}
+```
+
+To try this you can run the following command in `/src` (change the target name appropriately to `linux` or `macos` or `windows`):
+
+```bash
+tipi . -t <target>
+./build/linux-cxx17/bin/test_package -v
+```
+
+To develop `cxxopts` using tipi run the following command at the root of the repository:
+
+```bash
+tipi . -t <target> --test all -v
+```
+{
+    "jarro2783/cxxopts": { }
+}
 \ No newline at end of file
+link_a.cpp
+link_b.cpp
 \ No newline at end of file