diff --git a/.github/lc_flow.png b/.github/lc_flow.png new file mode 100644 index 0000000..e93add0 Binary files /dev/null and b/.github/lc_flow.png differ diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 24c5044..0000000 --- a/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*__pycache__ -rev.txt \ No newline at end of file diff --git a/README.md b/README.md index 13cde8f..8a3db4e 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,12 @@ Reetkode My personal collection of [LeetCode](https://leetcode.com/) solutions done in multiple languages, shared for learning and reference. 😃 -This README is generated using the following custom-built **Python** scripts: [`lc_markdown.py`](scripts/lc_markdown.py), [`lc_chart.py`](scripts/lc_chart.py), and [`lc_stats.py`](scripts/lc_stats.py), as part of a **GitHub Actions** [workflow](.github/workflows/main.yml) which runs during checks within pull requests made to `main` branch, updating the content and organising solution files prior to merging. -*** +This README is generated using the following custom-built **Python** scripts: [`lc_markdown.py`](scripts/lc_markdown.py), [`lc_chart.py`](scripts/lc_chart.py), and [`lc_stats.py`](scripts/lc_stats.py), as part of an automated **GitHub Actions** [workflow](.github/workflows/main.yml) which runs during checks within pull requests made to the `main` branch, updating the README content and organising solution files prior to merging. + +The following diagram illustrates the action flow of using these [scripts](scripts/): +![Script flow](.github/lc_flow.png?) +*** ## Progress Overview ![LeetCode stats](.github/lc_chart.png?) @@ -252,3 +255,5 @@ This README is generated using the following custom-built **Python** scripts: [` |**3541**|🟩 Easy|⚙️|[Find Most Frequent Vowel And Consonant](https://lcid.cc/3541)|| |**3550**|🟩 Easy|⚙️|[Smallest Index With Digit Sum Equal To Index](https://lcid.cc/3550)|| + +####
[🔝Return to top](#reetkode)
\ No newline at end of file diff --git a/scripts/lc_constants.py b/scripts/lc_constants.py index 615ce66..bbc4e58 100644 --- a/scripts/lc_constants.py +++ b/scripts/lc_constants.py @@ -1,6 +1,7 @@ REETKODE_SOLUTION_URL = "{folder}/{filename}" REETKODE_ICON_URL = ".github/icons/{icon}" REETKODE_CHART_URL = ".github/lc_chart.png?" +REETKODE_FLOW_URL = ".github/lc_flow.png?" LEETCODE_PROBLEM_URL = "https://lcid.cc/{id}" IGNORED_DIRS = (".git", ".github", "icons", "scripts") diff --git a/scripts/lc_markdown.py b/scripts/lc_markdown.py index b545753..09aea88 100644 --- a/scripts/lc_markdown.py +++ b/scripts/lc_markdown.py @@ -104,11 +104,17 @@ def markdown_leetcode() -> None: readme_file.new_line() readme_file.new_line(text= "This README is generated using the following custom-built **Python** scripts: [`lc_markdown.py`](scripts/lc_markdown.py), [`lc_chart.py`](scripts/lc_chart.py), and [`lc_stats.py`](scripts/lc_stats.py), " + - "as part of a **GitHub Actions** [workflow](.github/workflows/main.yml) which runs during checks within pull requests made to `main` branch, updating the content and organising solution files prior to merging." + "as part of an automated **GitHub Actions** [workflow](.github/workflows/main.yml) which runs during checks within pull requests made to the `main` branch, updating the README content and organising solution files prior to merging." ) - readme_file.new_line(text="***") readme_file.new_line() + flow_link_url = lcc.REETKODE_FLOW_URL + readme_file.new_line(text="The following diagram illustrates the action flow of using these [scripts](scripts/):") + readme_file.new_line() + + readme_file.new_line(readme_file.new_inline_image(text="Script flow", path=flow_link_url)) + readme_file.new_line(text="***") + # data showing the number of LeetCode problems solved, grouped by difficulty level and programming language # key = programming language, value = mapping of each difficulty level to the number of problems solved chart_leetcode() @@ -189,6 +195,8 @@ def markdown_leetcode() -> None: readme_file.new_table(columns=cols_num, rows=rows_num + 1, text=cells, text_align="left") readme_file.new_line() + readme_file.new_line(text='####
[🔝Return to top](#reetkode)
') + # generate README readme_file.create_md_file() print(f"[SUCCESS] README generated (table included: {rows_num} rows x {cols_num} columns)")