diff --git a/tools/oneclick/prestudy/YAML/args_readme.txt b/tools/oneclick/prestudy/YAML/args_readme.txt index 3fd78bff6ddf8b758c4f48b5df91fea22091c7d5..f191316d8fae41249319cf7e4a2bd1391749084f 100644 --- a/tools/oneclick/prestudy/YAML/args_readme.txt +++ b/tools/oneclick/prestudy/YAML/args_readme.txt @@ -1,4 +1,21 @@ -Howto for new tools. +This readme is an introduction to py_args_lib. + +Contents: +1) Demo of py_args_lib +2) How to develop new tool scripts that use py_args_lib +3) Examples of tool scripts that use py_args_lib + + + +1) Demo of py_args_lib + +./args_demo.py -h # help +./args_demo.py -s unb1_minimal_sopc -v INFO # show system.yaml contents +./args_demo.py -p unb1_board dp -v INFO # show peripheral.yaml contents + + + +2) How to develop new tool scripts that use py_args_lib # import all from py_args_lib from py_args_lib import * @@ -21,3 +38,22 @@ system = System(filename=[*.system.yaml]) peripheral = system.peripherals['peripheral_name'] + +3) Examples of tool scripts that use py_args_lib + +a) Create pdf documentation (very draft) + +./args_documentation.py -s unb1_minimal_sopc # system with all it peripherals +okular unb1_minimal_sopc.pdf + +./args_documentation.py -p unb1_board dp # only the peripheral +okular unb1_board.pdf + + +b) Create ROM system info for Uniboard + +./uniboard_rom_system_info.py -s unb1_minimal_sopc # with self generated base addresses +more unb1_minimal_sopc.reg + +./uniboard_rom_system_info.py -s unb1_minimal_sopc -q # using base addresses from sopc file (via -q) +more unb1_minimal_sopc.reg