diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml index df6003c..e10e340 100644 --- a/.github/workflows/generate-readme.yml +++ b/.github/workflows/generate-readme.yml @@ -30,7 +30,7 @@ jobs: run: pip install -r requirements.txt || true - name: Run script to generate README - run: python ./source/scripts/readme_generator.py + run: python ./source/scripts/generators/readme_generator.py - name: Commit and push changes run: | diff --git a/resources/dev/PENDINGREVIEW.md b/resources/dev/PENDINGREVIEW.md new file mode 100644 index 0000000..e69de29 diff --git a/source/components/header.md b/source/components/header.md index 6f13b2f..277bcfa 100644 --- a/source/components/header.md +++ b/source/components/header.md @@ -38,24 +38,6 @@ This list aims to serve as a single centralized location for the best of open so Definitive-opensource was initially a single markdown file that was edited directly. However, as the list scaled, this manual approach proved cumbersome and limited. Additionally, as popularity increased, we recieved many requests for README's of individual platforms - something that would be not be realistic to do manually.
As of v0.6.2-beta, the project was fundamentally re-made. Categories and applications were put in categories.json and applications.json, respectively. Python scripts were made to generate one main list and more platform-specific lists. This was paired with GitHub actions to run the scripts when any changes were made. This makes refactoring the list format far easier and eliminates typos. -
- The project architecture is as follows: -
-
- definitive-opensource/
- ├── assets/
- ├── readmes/
- ├── resources/
- │ ├── backup/
- │ └── dev/
- ├── source/
- │ ├── components/
- │ ├── data/
- │ ├── scripts/
- | └── utils/
- │ └── testing/
- └── README.md
-
## Project Status
diff --git a/source/scripts/contents_generator.py b/source/scripts/generators/contents_generator.py
similarity index 100%
rename from source/scripts/contents_generator.py
rename to source/scripts/generators/contents_generator.py
diff --git a/source/scripts/mainheader_generator.py b/source/scripts/generators/mainheader_generator.py
similarity index 100%
rename from source/scripts/mainheader_generator.py
rename to source/scripts/generators/mainheader_generator.py
diff --git a/source/scripts/readme_generator.py b/source/scripts/generators/readme_generator.py
similarity index 100%
rename from source/scripts/readme_generator.py
rename to source/scripts/generators/readme_generator.py
diff --git a/source/scripts/tableofcontents_generator.py b/source/scripts/generators/tableofcontents_generator.py
similarity index 100%
rename from source/scripts/tableofcontents_generator.py
rename to source/scripts/generators/tableofcontents_generator.py
diff --git a/source/scripts/maintenence/activity_checker.py b/source/scripts/maintenence/activity_checker.py
new file mode 100644
index 0000000..e69de29
diff --git a/source/scripts/maintenence/description_updator.py b/source/scripts/maintenence/description_updator.py
new file mode 100644
index 0000000..e69de29
diff --git a/source/scripts/maintenence/stars_updator.py b/source/scripts/maintenence/stars_updator.py
new file mode 100644
index 0000000..e69de29