Skip to content

Added instructions on how to use argh with tipi.build #70

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

Open
pysco68 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added instructions on how to use argh with tipi.build #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,25 @@ target_link_libraries(${MY_TARGET_NAME} argh)

```

## Tipi.build

`argh` can be easily used in [tipi.build](https://tipi.build) projects simply by adding the following entry to your `.tipi/deps`:

```json
{
"adishavit/argh": { "x": [ "*.cpp" ]}
}
```

> `argh` itself is a header-only library hence the exclusion of all `.cpp` files above. This isn't stricly required to inlcude `argh` but speeds up the build.
Copy link
Owner

@adishavit adishavit Mar 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you say it "speeds up the build."?
There are no .cpp files - it is a header only library.
The .cpp files are only for testing and the example files. You do not need them for using argh.

Copy link
Author

@pysco68 pysco68 May 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In tipi we use a source scan based approach to dependency management, instead of having you provide some type of script to make argh usable in someone else's project. Basically when someone adds that line to his .tipi/deps files, tipi will pull argh straight from Github and install it in a project specific sysroot.

By excluding the *.cpp files that are not actually part of argh (but rather only test cases and examples) these files are not being scanned or compiled which can save a bit of time.

Copy link
Owner

@adishavit adishavit May 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't completely understand.

So is adding that json snippet with the *.cpp needed or not?
Is there some way or a need to exclude stuff?


To try this you can run the following command in `/test_package` (change the target name appropriately to `linux` or `macos` or `windows`):

```bash=
tipi . -t <target>
./build/linux-cxx17/bin/test_package -v
```

## Buck

The [Buck](https://buckbuild.com/) build system is also supported.
Expand Down
3 changes: 3 additions & 0 deletions test_package/.tipi/deps
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"adishavit/argh": { "x": [ "*.cpp" ]}
}