author | Olivier Brunel
<jjk@jjacky.com> 2023-07-07 07:03:59 UTC |
committer | Olivier Brunel
<jjk@jjacky.com> 2023-07-24 10:16:43 UTC |
parent | 0a7112546655aa414a94879522a6e8f457c0d5a3 |
meta/README.git | +22 | -21 |
diff --git a/meta/README.git b/meta/README.git index a17222c..7f801f1 100644 --- a/meta/README.git +++ b/meta/README.git @@ -17,34 +17,35 @@ are a few steps required in order to get things good to go : 3. Good, but there might be other components needed to build this software. Worry not, comain can help you and set them all up for you. To do so, simply - run `comain/getdeps` + run `comain/getdeps cpnt` Each components will then be cloned and checked out as needed. Should you want to do so manually, you can instead run `comain/getdeps list` and it will only list all required components and their minimum version. + As an added bonus, it will also list dependencies. - By default, in addition to components `comain/getdeps` will also set up - dependencies that are marked to be included in the release tarball. Those are - usually also set to be statically linked, thus providing no runtime - dependency. - - If you do *not* want that, and would like only components to be processed, - simply run `comain/getdeps cpnt` instead. + If you just want to see what would happen, an option `--dry-run` (or `-n`) + can be used, e.g: `comain/getdeps -n cpnt` 4. Now that components are all set up, there might be dependencies as well - - that is, librairies needed to build the software. - - Some dependencies might be classified as "internal", meaning their source - code is included in release tarballs and by default they're linked - statically, thus leading to no runtime dependencies. - Usually, there's only one such dependency, lila's very own `limb` - - If you didn't use `comain/getdeps` on step 3 and now wishes for those to be - setup by comain, you can use `comain/getdeps intdeps` - - You can also use comain to clone repos of *all* dependencies by running - `comain/getdeps alldeps` or pick one and use `comain/getdeps dep NAME` where - `NAME` is to be the name of the dependency to clone the repo of. + that is, libraries needed to build the software. + + As a way to help, it is possible to use them in so-called "internal" mode, + which simply means instead of installing the library into the system, you can + just put it in the `deps` folder. + Of course, you'll need to build it as well. By default such "internal" + dependencies are linked statically, so only building static libraries is + enough. + + Once again, a little helper might come in handy: `comain/getdeps deps` will + do for libraries what it did for components : clone their repos into `deps` + and checking the needed branch/tag. + Except that it does so recursively, so all dependencies of the dependencies + will also be cloned. + + Additionally, you can then have them all built using `comain/blddeps` + Note that it does so recursively, so all dependencies of the dependencies + will also be built, assuming it is available in the `deps` folder of course. 5. That's it, finally you're ready! You can now use `./configure` and `make` as usual.