deathbybandaid/dashboard-icons
1
0
Fork 0
mirror of https://github.com/walkxhub/dashboard-icons.git synced 2025-12-06 06:36:59 -05:00
Code Issues Projects Releases Wiki Activity

Update README.md, add #63 #62 #60 #59 #58 #54

Browse Source
This commit is contained in:
WalkxCode 2022-03-21 15:06:13 +01:00
parent ac9f8f6f60
commit 7fa7b77678
No known key found for this signature in database
GPG Key ID: A4728B5A76CE4B6E
1 changed files with 53 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
scripts/generate_readme.py
View File

@ -10,22 +10,62 @@ if __name__ == "__main__":
img_tags = [generate_img_tag(x) for x in imgs]
with open("README.md", "wt", encoding="UTF-8") as f:
f.write("# Dashboard Icons\n\n")
f.write("### The best Dashboards:\n\n")
f.write("<p align = \"center\" >\n")
f.write(" <h3 align = \"center\" > Dashboard Icons </h3>\n")
f.write("\n")
f.write(" <p align = \"center\" >\n")
f.write(" Dashboard Icons for your selfhosted services.\n")
f.write(" <br/>\n")
f.write(
"- [Dashy (Icons Natively Supported)](https://github.com/Lissy93/dashy)\n")
f.write("- [Homer Dashboard](https://github.com/bastienwirtz/homer)\n")
" <a href = \"#icons\" > <strong > Get icons »</strong> </a>\n")
f.write("</p>\n")
f.write("\n")
f.write("# Table of Contents\n")
f.write("- [Table of Contents](#table-of-contents)\n")
f.write("- [Getting Started](#getting-started)\n")
f.write(" - [Dashboards](#dashboards)\n")
f.write(" - [Installation](#installation)\n")
f.write("- [Icons](#icons)\n")
f.write("- [Legal](#legal)\n")
f.write("\n")
f.write("<!-- GETTING STARTED -->\n")
f.write("# Getting Started\n")
f.write("\n")
f.write("## Dashboards\n")
f.write("\n")
f.write(
"There's multiple Dashboards available. Here are some of the popular ones.\n")
f.write("\n")
f.write("- [Dashy*](https://github.com/Lissy93/dashy)\n")
f.write(
"- [Homer Dashboard](https://github.com/bastienwirtz/homer)\n")
f.write("- [Heimdall](https://github.com/linuxserver/Heimdall)\n")
f.write("- [Organizr(v2)](https://github.com/causefx/Organizr)\n")
f.write("- [Flame](https://github.com/pawelmalak/flame)\n")
f.write("- [SUI](https://github.com/jeroenpardon/sui)\n\n\n")
f.write("- [SUI](https://github.com/jeroenpardon/sui)\n")
f.write("\n")
f.write("## Installation\n")
f.write(
"##### [How to download images on UNIX?](#how-to-download-images-on-unix-1)\n\n")
"_*Dashy natively supports all icons in this repo, and is synced automatically. (Clicking [this link](https://github.com/Lissy93/dashy/blob/master/docs/icons.md#home-lab-icons) will take you to the docs that explain how to use the integration.)_\n")
f.write("\n")
f.write("To download an icon, simple `Right click > Save image`.\n")
f.write("\n")
f.write(
"##### [How to use icons in Dashy natively?](https://github.com/Lissy93/dashy/blob/master/docs/icons.md#home-lab-icons)\n\n\n")
"For non-desktop operating systems, or people that prefer to use terminal.\n")
f.write("```sh\n")
f.write("$ curl https://raw.githubusercontent.com/walkxhub/dashboard-icons/master/png/example.png > example.png\n")
f.write("```\n")
f.write("or\n")
f.write("```sh\n")
f.write("$ wget https://raw.githubusercontent.com/walkxhub/dashboard-icons/master/png/example.png - O example.png\n")
f.write("```\n")
f.write("\n")
f.write("<!-- ICONS -->\n")
f.write("# Icons\n")
f.write(" ".join(img_tags))
f.write("\n\n\n")
f.write("---\n\n### How to download images on UNIX?\n\n\n`UNIX`\n\n```bash\n\n$ curl https://raw.githubusercontent.com/WalkxCode/dashboard-icons/master/png/example.png > example.png\n\n```\nor\n```bash\n\n$ wget https://raw.githubusercontent.com/WalkxCode/dashboard-icons/master/png/example.png -O example.png\n\n```")
f.write("\n\n\n---\n\n## Trademark Legal Notices\n\n(Almost) All product names, trademarks and registered trademarks in the images in this repository, are property of their respective owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.\n\n\nThe use of these names, trademarks and brands appearing in these image files, do not imply endorsement.")
f.write(
"\n\n\n---\n\n## Mentions\nThis project has been mentioned on:\n\n#### The Official Dashy Docs\n[Home-Lab Icons](https://github.com/Lissy93/dashy/blob/master/docs/icons.md#home-lab-icons)\n\n#### Awesome Open Source\n[YouTube](https://youtu.be/QsQUzutGarA?t=580)\n[Show notes](https://shownotes.opensourceisawesome.com/dashy-powerful-informative/)\n\n#### r/selfhosted\n[u/BackedUpBooty](https://www.reddit.com/r/selfhosted/comments/qu11pf/comment/hkp7v3o/?utm_source=share&utm_medium=web2x&context=3)\n[u/marusb](https://www.reddit.com/r/selfhosted/comments/q4tnac/comment/hg2sovy/?utm_source=share&utm_medium=web2x&context=3)\n[u/Jonathan_Fu](https://www.reddit.com/r/selfhosted/comments/podb3c/comment/hcxf4eb/?utm_source=share&utm_medium=web2x&context=3)")
f.write("\n\n")
f.write("<!-- LEGAL -->\n")
f.write("# Legal\n")
f.write("(Almost) All product names, trademarks and registered trademarks in the images in this repository, are property of their respective owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.\n")
f.write("\n")
f.write("The use of these names, trademarks and brands appearing in these image files, do not imply endorsement.\n")