From 17170b6817e73ff4856084623ec3c8172525d285 Mon Sep 17 00:00:00 2001 From: Vladislav Yarmak Date: Fri, 15 Nov 2019 03:25:40 +0200 Subject: [PATCH] autogen: change directory naming; add docs --- .../{readme_autogen => readme-autogen}/.gitignore | 0 tools/readme-autogen/README.md | 14 ++++++++++++++ .../readme_autogen.py | 0 .../templates/linux_link_row.tmpl | 0 .../templates/linux_nolink_row.tmpl | 0 .../templates/linux_readme_master.tmpl | 0 .../templates/markdown_link.tmpl | 0 .../templates/windows_driver_row.tmpl | 0 .../templates/windows_os_section.tmpl | 0 .../templates/windows_product_section.tmpl | 0 .../templates/windows_readme_master.tmpl | 0 11 files changed, 14 insertions(+) rename tools/{readme_autogen => readme-autogen}/.gitignore (100%) create mode 100644 tools/readme-autogen/README.md rename tools/{readme_autogen => readme-autogen}/readme_autogen.py (100%) rename tools/{readme_autogen => readme-autogen}/templates/linux_link_row.tmpl (100%) rename tools/{readme_autogen => readme-autogen}/templates/linux_nolink_row.tmpl (100%) rename tools/{readme_autogen => readme-autogen}/templates/linux_readme_master.tmpl (100%) rename tools/{readme_autogen => readme-autogen}/templates/markdown_link.tmpl (100%) rename tools/{readme_autogen => readme-autogen}/templates/windows_driver_row.tmpl (100%) rename tools/{readme_autogen => readme-autogen}/templates/windows_os_section.tmpl (100%) rename tools/{readme_autogen => readme-autogen}/templates/windows_product_section.tmpl (100%) rename tools/{readme_autogen => readme-autogen}/templates/windows_readme_master.tmpl (100%) diff --git a/tools/readme_autogen/.gitignore b/tools/readme-autogen/.gitignore similarity index 100% rename from tools/readme_autogen/.gitignore rename to tools/readme-autogen/.gitignore diff --git a/tools/readme-autogen/README.md b/tools/readme-autogen/README.md new file mode 100644 index 0000000..103ed76 --- /dev/null +++ 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. diff --git a/tools/readme_autogen/readme_autogen.py b/tools/readme-autogen/readme_autogen.py similarity index 100% rename from tools/readme_autogen/readme_autogen.py rename to tools/readme-autogen/readme_autogen.py diff --git a/tools/readme_autogen/templates/linux_link_row.tmpl b/tools/readme-autogen/templates/linux_link_row.tmpl similarity index 100% rename from tools/readme_autogen/templates/linux_link_row.tmpl rename to tools/readme-autogen/templates/linux_link_row.tmpl diff --git a/tools/readme_autogen/templates/linux_nolink_row.tmpl b/tools/readme-autogen/templates/linux_nolink_row.tmpl similarity index 100% rename from tools/readme_autogen/templates/linux_nolink_row.tmpl rename to tools/readme-autogen/templates/linux_nolink_row.tmpl diff --git a/tools/readme_autogen/templates/linux_readme_master.tmpl b/tools/readme-autogen/templates/linux_readme_master.tmpl similarity index 100% rename from tools/readme_autogen/templates/linux_readme_master.tmpl rename to tools/readme-autogen/templates/linux_readme_master.tmpl diff --git a/tools/readme_autogen/templates/markdown_link.tmpl b/tools/readme-autogen/templates/markdown_link.tmpl similarity index 100% rename from tools/readme_autogen/templates/markdown_link.tmpl rename to tools/readme-autogen/templates/markdown_link.tmpl diff --git a/tools/readme_autogen/templates/windows_driver_row.tmpl b/tools/readme-autogen/templates/windows_driver_row.tmpl similarity index 100% rename from tools/readme_autogen/templates/windows_driver_row.tmpl rename to tools/readme-autogen/templates/windows_driver_row.tmpl diff --git a/tools/readme_autogen/templates/windows_os_section.tmpl b/tools/readme-autogen/templates/windows_os_section.tmpl similarity index 100% rename from tools/readme_autogen/templates/windows_os_section.tmpl rename to tools/readme-autogen/templates/windows_os_section.tmpl diff --git a/tools/readme_autogen/templates/windows_product_section.tmpl b/tools/readme-autogen/templates/windows_product_section.tmpl similarity index 100% rename from tools/readme_autogen/templates/windows_product_section.tmpl rename to tools/readme-autogen/templates/windows_product_section.tmpl diff --git a/tools/readme_autogen/templates/windows_readme_master.tmpl b/tools/readme-autogen/templates/windows_readme_master.tmpl similarity index 100% rename from tools/readme_autogen/templates/windows_readme_master.tmpl rename to tools/readme-autogen/templates/windows_readme_master.tmpl