autogen: change directory naming; add docs

2024-12-26 22:43:34 +00:00 · 2019-11-15 03:25:40 +02:00 · 2019-11-15 03:25:40 +02:00 · 17170b6817
commit 17170b6817
parent 89b8fa6eed
11 changed files with 14 additions and 0 deletions
--- a/tools/readme-autogen/.gitignore
+++ b/tools/readme-autogen/.gitignore
--- a/tools/readme-autogen/README.md
+++ b/tools/readme-autogen/README.md
@ -0,0 +1,14 @@
+readme-autogen
+==============
+
+readme-autogen is a tool for internal usage, which purpose is to simplify maintenance of fresh and correct README files for this project.
+
+It rebuilds REAME files from templates in `template` directory and driver data specified in `drivers.json` file.
+
+## Requirements
+
+* Python 3.4+
+
+## Usage
+
+Just run script. It will update files in your repo working copy.
--- a/tools/readme-autogen/readme_autogen.py
+++ b/tools/readme-autogen/readme_autogen.py
--- a/tools/readme-autogen/templates/linux_link_row.tmpl
+++ b/tools/readme-autogen/templates/linux_link_row.tmpl
--- a/tools/readme-autogen/templates/linux_nolink_row.tmpl
+++ b/tools/readme-autogen/templates/linux_nolink_row.tmpl
--- a/tools/readme-autogen/templates/linux_readme_master.tmpl
+++ b/tools/readme-autogen/templates/linux_readme_master.tmpl
--- a/tools/readme-autogen/templates/markdown_link.tmpl
+++ b/tools/readme-autogen/templates/markdown_link.tmpl
--- a/tools/readme-autogen/templates/windows_driver_row.tmpl
+++ b/tools/readme-autogen/templates/windows_driver_row.tmpl
--- a/tools/readme-autogen/templates/windows_os_section.tmpl
+++ b/tools/readme-autogen/templates/windows_os_section.tmpl
--- a/tools/readme-autogen/templates/windows_product_section.tmpl
+++ b/tools/readme-autogen/templates/windows_product_section.tmpl
--- a/tools/readme-autogen/templates/windows_readme_master.tmpl
+++ b/tools/readme-autogen/templates/windows_readme_master.tmpl