diff options
Diffstat (limited to 'utils/rockbox_api/README')
-rw-r--r-- | utils/rockbox_api/README | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/utils/rockbox_api/README b/utils/rockbox_api/README new file mode 100644 index 0000000000..1ed251c918 --- /dev/null +++ b/utils/rockbox_api/README | |||
@@ -0,0 +1,29 @@ | |||
1 | ============================== | ||
2 | generate.php | ||
3 | ============================== | ||
4 | |||
5 | php generate.php > output.txt | ||
6 | |||
7 | -------------- | ||
8 | Generates output.txt of apps/plugin.h | ||
9 | |||
10 | ============================== | ||
11 | update.php | ||
12 | ============================== | ||
13 | |||
14 | php update.php input_file.txt > output.txt | ||
15 | |||
16 | -------------- | ||
17 | Updates input_file.txt with newer values of apps/plugin.h | ||
18 | |||
19 | ============================== | ||
20 | gen_html.php | ||
21 | ============================== | ||
22 | |||
23 | php gen_html.php input_file.txt | ||
24 | |||
25 | -------------- | ||
26 | Generates HTML output of input_file.txt in output/*.html | ||
27 | |||
28 | Known issues: | ||
29 | * [F[function]] doesn't work with functions outside of the current .html \ No newline at end of file | ||