diff options
Diffstat (limited to 'tools/release/README')
-rw-r--r-- | tools/release/README | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/tools/release/README b/tools/release/README index 294c7ba136..19e4f0735c 100644 --- a/tools/release/README +++ b/tools/release/README | |||
@@ -5,28 +5,30 @@ | |||
5 | Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ | 5 | Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ |
6 | \/ \/ \/ \/ \/ | 6 | \/ \/ \/ \/ \/ |
7 | 7 | ||
8 | This directory contains useful scripts when creating and building | 8 | This directory the scripts used to create release artifacts. All |
9 | releases. The plan is to hopefully create a single top-level script that will | 9 | generated data is stored in an output directory (called "output"). |
10 | run everything needed to make a complete and full release and put all | 10 | |
11 | generated data into a separate output directory. | 11 | All of these scripts take two arguments; the git tag and the version string. |
12 | 12 | ||
13 | NOTE that these scripts assume that you have the necessary compilers already | 13 | NOTE that these scripts assume that you have the necessary compilers already |
14 | present in your PATH. | 14 | present in your PATH. |
15 | 15 | ||
16 | The scripts: | 16 | The scripts: |
17 | 17 | ||
18 | bins.pl Builds all the binary rockbox zip files. | 18 | bins.pl Builds all the binary rockbox zip files |
19 | 19 | manuals.pl Builds all manuals (pdf and html-zip) | |
20 | manuals.pl Builds all manuals | 20 | sources.sh Builds the source tarball |
21 | voices.pl Builds all "complete enough" voice files | ||
21 | 22 | ||
22 | voices.pl Builds all english voice files | 23 | Only "stable" targets, their manuals, and a selection of voice files are built; |
24 | these are designated in tools/builds.pm | ||
23 | 25 | ||
24 | tarball.sh Builds the source tarball | 26 | Example: |
25 | 27 | ||
28 | tools/release/sources.sh v3.15-final 3.15 | ||
26 | 29 | ||
27 | STATUS | 30 | Other notes: |
28 | 31 | ||
29 | All these scripts have a "version" variable at the top that needs editing and | 32 | * Update www/tools/dailybuild-voices.pl file to add the release target |
30 | each of this script needs to be run at the source tree root to function. Most | 33 | voice list! |
31 | of them put their generated files in a subdir called 'output' which the | 34 | * Update release target in tools/builds.pm |
32 | scripts create. | ||