X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?p=subdirmk.git;a=blobdiff_plain;f=subdirmk%2FREADME;h=d43c04b2c0c56922c11d300e272c66370f1f8004;hp=d2b3c469e07986139a6e4dd9aa8c56c6ece2ff9d;hb=58859755f916bd326f2bbbbac12654a92c47328f;hpb=96ef3343f7effb47f94e60309198c57f9e2b228b diff --git a/subdirmk/README b/subdirmk/README index d2b3c46..d43c04b 100644 --- a/subdirmk/README +++ b/subdirmk/README @@ -239,6 +239,33 @@ project) are best avoided. If you name your variables in ALL CAPS and your subdirectories in lower case with `-' rather than `_', there will be no confusion. +Incorporating this into your project +------------------------------------ + +Use `git-subtree' to merge the subdirmk/ directory. You may find it +useful to symlink the DEVELOPER-CERTIFICATE file (git can store +symlinks as symlinks - just `git add' the link). And you probably +want to mention the situation in your top-level COPYING. + +Symlink autogen.sh into your project toplevel. + +In your configure.ac, say + + m4_include([subdirmk/subdirmk.ac]) + SUBDIRMK_SUBDIRS([...list of subdirectories in relative syntax...]) + +Write a Subdir.sd.mk in each directory. The toplevel one should +probably contain: + + include subdirmk/usual.mk + include subdirmk/regen.mk + +Write a Perdir.sd.mk in the toplevel, if you want. It should probably +have: + + &:include subdirmk/cdeps.sd.mk + &:include subdirmk/clean.sd.mk + Legal information -----------------