diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml index 0a04b06..e43b971 100644 --- a/.github/workflows/generate-readme.yml +++ b/.github/workflows/generate-readme.yml @@ -16,14 +16,9 @@ jobs: - name: Checkout repository uses: actions/checkout@v3 - - name: Set up dependencies - run: | - sudo apt-get update - sudo apt-get install -y gawk - - name: Generate README.md run: | - awk -f scripts/awk/addGithubShields.awk _README.md | awk -f scripts/awk/makeShieldsSquare.awk > README.md + python3 generate_readme.py _README.md > README.md - name: Commit changes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0d15c4..4cbf502 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,11 @@ Please note that this project is released with a [Contributor Code of Conduct](c Ensure your pull request adheres to the following guidelines: -- Edit and modify the `README.md` file. +- Edit and modify the `_README.md` file. `README.md` is automatically generated from this file. - Ensure that the project you submit does not duplicate existing entries. - Ensuring that the items you submit have at least working documentation for the description. - Ensure that you add new item in alphabetical order -- Ensure that the new item have correct category. suggest new one if you find suitable +- Ensure that the new item have correct category. Suggest new one if you find suitable - Submit a separate PR for each item. - Format the PR title as `Add item: item name`/`Fix item: item name`. diff --git a/main.py b/generate_readme.py similarity index 100% rename from main.py rename to generate_readme.py