v1.5 branch refresh based upon upstream master @ c8677ca89e53e3be7988d54280fce166cc894a7e
[librecmc/librecmc.git] / package / utils / jboot-tools / README.md
1 Userspace utilties for jboot based devices config partition read
2
3 ## Building
4
5 ```
6 mkdir build
7 cd build
8 cmake /path/to/jboot-tools
9 make
10 ```
11
12 ## Usage
13
14 All command line parameters are documented:
15 ```
16 jboot_config_read -h
17 ```
18
19 Show all stored MACs:
20 ```
21 jboot_config_read -m -i PATH_TO_CONFIG_PARTITIO
22 ```
23
24 Extract wifi eeprom data:
25 ```
26 jboot_config_read  -i PATH_TO_CONFIG_PARTITION -e OUTPUT_PATH
27 ```
28
29
30 ## LICENSE
31
32 See `LICENSE`:
33
34     This program is free software; you can redistribute it and/or modify
35     it under the terms of the GNU General Public License as published by
36     the Free Software Foundation; either version 2 of the License, or
37     (at your option) any later version.
38
39     This program is distributed in the hope that it will be useful,
40     but WITHOUT ANY WARRANTY; without even the implied warranty of
41     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
42     GNU General Public License for more details.
43
44     You should have received a copy of the GNU General Public License along
45     with this program; if not, write to the Free Software Foundation, Inc.,
46     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.