README: document how to provide source code

Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>

1 files changed, 25 insertions, 12 deletions

diff --git a/README.txt b/README.txt
index 7320dc8..52b1f0e 100644
--- a/README.txt
+++ b/README.txt
@@ -186,24 +186,37 @@ because it doesn't have access to your ssh keys, you can simply export the
 Replicant source directory with sshfs to your main computer which has all the
 access and run the releasetag.sh from it.
 
-Building the source:
---------------------
+Building the source tarball:
+----------------------------
 Once the tagging is done, you need to re-download the source code again from the
-new manifest tag as tools like release.sh expect the manifest to have the release
-tag.
+new manifest tag as tools like release.sh expect the manifest to have the
+release tag.
+
 Doing it from scratch will make sure that the repositories are fetchable and
 that nothing went wrong.
 
-Once this is done, it would be a good idea to make sure that you have enough
-space for building the release: For a release, you will need to build Replicant
-for all the supported devices, so it can take more space than usual.
+The make_source_tarball.sh script can do that in an efficient way: it will not
+download the full history but only the last commit and the state at the last
+commit of each git repository, and it will then generate a tarball out of it.
+
+The Replicant release will have to be built in the directory
+make_source_tarball.sh will have created. This way we can simply publish that
+tarball along with the images to make sure that we are providing complete and
+corresponding source code in the same location than the images.
 
-As a point of comparison, for the Replicant 6.0 0004 RC2 release which supported
-10 targets (espresso3g, espressowifi, i9100, i9300, i9305, maguro, n5100, n5110,
-n7000, n7100) after the build the replicant-6.0 directory took about 219 GiB
-(228773716 bytes).
+For Replicant 6.0 0004 RC5, the replicant-6.0-0004-rc5.tar.xz tarball is about
+6.3GiB (6662406932 bytes) and once the images for all the supported devices are
+built, the replicant-6.0-0004-rc5 directory takes about 211GiB (223219395971
+bytes).
+
+So you also need to make sure to have at least about 220 GiB of free space
+before starting the build.
+
+Building the images:
+--------------------
+At this point, you can finally start building all the images with
+build_release.sh.
 
-After that, you can finally start building all the images with build_release.sh.
 The build process can many hours on an older computer, so it's a good idea to
 plan that ahead. For instance, if your build computer is noisy and that its
 noise can prevent you from sleeping, you might want considering launching the