From 75521ca67fe9ad7f18de8e02504f1d656c8dc1a3 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Thu, 23 Dec 2021 21:15:18 -0500 Subject: add instructions on managing branch ‘prebuilt’ to top-level README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit (These instructions are what works for me; people should feel free to augment them w/ their own preferred workflows.) --- README | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index dda29a28..206d3055 100644 --- a/README +++ b/README @@ -14,4 +14,20 @@ Then, do "make html" for HTML, "make texinfo" for Texinfo, etc. The output is in subdir ‘_build’. -TODO: Add instructions on how to build/export/integrate ‘prebuilt’ docs. +Branch ‘prebuilt’ is special. Its contents (or a subset) are used as +submodules in other Git repos (e.g., Exchange, Merchant, Sync). + +One approach that works well (so far) for ttn is to do +(presuming that the current directory is named ‘docs’): + + $ cd .. + $ git clone -b prebuilt --reference docs \ + git+ssh://git@git.taler.net/docs.git \ + docs-prebuilt + +This creates Git repo docs-prebuilt as a peer to the current repo. + +This way, you can build in this directory (i.e., "make man" or whatever) +and then copy to ../docs-prebuilt/man/* what files need to be updated. +In that repo, you can commit changes and push to git.taler.net as normal, +all without having to do "git checkout" in either repo. -- cgit v1.2.3