summaryrefslogtreecommitdiffstats
path: root/tools/release/README
blob: 19e4f0735c5163fa8b2e43f7cae21bc3a9211576 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
             __________               __   ___.
   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
                     \/            \/     \/    \/            \/

 This directory the scripts used to create release artifacts.  All
 generated data is stored in an output directory (called "output").

 All of these scripts take two arguments; the git tag and the version string.

 NOTE that these scripts assume that you have the necessary compilers already
 present in your PATH.

 The scripts:

   bins.pl          Builds all the binary rockbox zip files
   manuals.pl       Builds all manuals (pdf and html-zip)
   sources.sh       Builds the source tarball
   voices.pl        Builds all "complete enough" voice files

  Only "stable" targets, their manuals, and a selection of voice files are built;
  these are designated in tools/builds.pm

 Example:

   tools/release/sources.sh v3.15-final 3.15

 Other notes:

   * Update www/tools/dailybuild-voices.pl file to add the release target
     voice list!
   * Update release target in tools/builds.pm