{"id":13478933,"url":"https://github.com/shariati/OS-Folder-Icons","last_synced_at":"2025-03-27T08:31:12.282Z","repository":{"id":44411421,"uuid":"111298129","full_name":"shariati/OS-Folder-Icons","owner":"shariati","description":"A collection of custom folder icons for (Mac, Linux and Windows)","archived":false,"fork":false,"pushed_at":"2024-06-06T22:56:05.000Z","size":135205,"stargazers_count":389,"open_issues_count":3,"forks_count":30,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-22T08:08:07.625Z","etag":null,"topics":["folder-icon","icon-pack","icons","macos"],"latest_commit_sha":null,"homepage":"https://shariati.github.io/OS-Folder-Icons/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shariati.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["shariati","sarah8131"],"patreon":null,"open_collective":null,"ko_fi":"shariati","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2017-11-19T13:34:13.000Z","updated_at":"2025-02-20T18:50:16.000Z","dependencies_parsed_at":"2022-07-12T18:21:01.322Z","dependency_job_id":"54406ad4-7163-479a-9a94-d73f51509a42","html_url":"https://github.com/shariati/OS-Folder-Icons","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shariati%2FOS-Folder-Icons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shariati%2FOS-Folder-Icons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shariati%2FOS-Folder-Icons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shariati%2FOS-Folder-Icons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shariati","download_url":"https://codeload.github.com/shariati/OS-Folder-Icons/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245809795,"owners_count":20676054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["folder-icon","icon-pack","icons","macos"],"created_at":"2024-07-31T16:02:06.082Z","updated_at":"2025-03-27T08:31:10.708Z","avatar_url":"https://github.com/shariati.png","language":"Python","readme":"# OS Folder Icons 📂\n\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT) \n[![CodeQL](https://github.com/shariati/OS-Folder-Icons/actions/workflows/codeql.yml/badge.svg)](https://github.com/shariati/OS-Folder-Icons/actions/workflows/codeql.yml)\n\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/S6S2QRA2Y)\n\nCollection of custom folder 📂 icons for MacOS, Linux, and Windows.\n\n## Overview\n\nThis repository contains a collection of custom folder icons for different operating systems. You can choose from a variety of icons to customize your folder appearance on MacOS, Linux, and Windows.\n\n## Requesting Folder Icons\n\nWe welcome suggestions for new folder icons! If you have specific icons you'd like to see added to the collection, please drop us a message by [creating a new issue](https://github.com/shariati/OS-Folder-Icons/issues/new).\n\n## Usage\n\nTo use the folder icons, simply download the repository. Inside the `icons` folder, you will find the icons categorized into different folders based on their respective brands, development languages, finance, games, operating systems, social media, virtualization, project management, and others.\n\n### Changing Folder Icon on Linux\n\n1. Right-click on a folder and select \"Properties.\"\n2. In the properties window, click on the framed icon located at the top left corner.\n3. Choose a new image by browsing through the icons available in the respective Linux folder.\n\n### Changing Folder Icon on Windows\n\n1. Right-click on a folder and select \"Properties.\"\n2. Go to the \"Customize\" tab and click on \"Change Icon\" in the \"Folder icons\" section.\n3. Choose a new image by browsing through the icons available in the respective Windows folder.\n\n![How to Change Folder Icon on Windows](https://user-images.githubusercontent.com/19328465/33271833-9a32a2ae-d39d-11e7-9318-56ec1e054ef8.gif)\n\n### Changing Folder Icon on Mac\n\n1. Right-click on a folder and select \"Get Info.\"\n2. Drag and drop an icon from the `.icns` files available in the respective Mac folder onto the icon preview located at the top left corner of the Get Info dialogue.\n\n![How to Use on Mac](https://user-images.githubusercontent.com/2625497/33240487-738316b8-d2f1-11e7-8c65-6d9c2de56c39.gif)\n\n## Folder Icon Collection\n\nThe icons are organized into the following folders:\n\n- Brands\n- Development\n- Finance\n- Games\n- Operating Systems\n- Social Media\n- Virtualization\n- Project Management\n- Others\n\nYou can find the respective icons for each category in their corresponding folders.\n\n## Repository Folder Structure\n\nHere is the folder structure of this repository:\n\n\n\n## Folder Structure\n\nHere is the folder structure of the repository:\n```bash\n├── LICENSE\n├── README.md\n├── docs\n│ ├── images\n│ └── index.md\n├── images\n│ ├── masks\n│ └── os_folders\n│ ├── linux\n│ ├── macos\n│ └── windows\n├── pytest.ini\n├── requirements.txt\n├── setup.py\n├── src\n│ ├── generate_readme.py\n│ ├── icon_generator\n│ │ ├── init.py\n│ │ ├── generator.py\n│ │ └── utils.py\n│ └── main.py\n└── tests\n├── test_generator.py\n└── test_utils.py\n```\n\nExplanation of each folder:\n\n- `docs`: Contains the documentation files, including the generated `index.md` file.\n- `images`: Contains the mask images and base folder images.\n  - `masks`: Contains the mask images used to apply on the base folder images.\n  - `os_folders`: Contains the base folder images categorized by operating systems.\n    - `linux`: Contains base folder images for Linux operating system.\n    - `macos`: Contains base folder images for macOS operating system.\n    - `windows`: Contains base folder images for Windows operating system.\n- `pytest.ini`: Configuration file for pytest.\n- `requirements.txt`: Lists the project dependencies.\n- `setup.py`: Setup script for the project.\n- `src`: Contains the source code files for the project.\n  - `generate_readme.py`: Script to generate the `index.md` file for documentation.\n  - `icon_generator`: Package containing the icon generation logic.\n    - `generator.py`: Contains the functions to generate folder icons.\n    - `utils.py`: Contains utility functions used in the generation process.\n  - `main.py`: Main script to run the icon generation process.\n- `tests`: Contains the test files for the project.\n  - `test_generator.py`: Tests for the icon\n\n\n## Prerequisites\n\nBefore running the project, make sure you have the following prerequisites installed on your system:\n\n- Python: Visit the [Python website](https://www.python.org/) and download the appropriate version of Python for your operating system. Follow the installation instructions provided.\n\n## Installing Dependencies\n\nTo install the project dependencies, follow these steps:\n\n1. Open a terminal or command prompt.\n2. Navigate to the root directory of the project.\n3. Run the following command to install the dependencies:\n\n```python\npip install -r requirements.txt\n```\n\nThis command will install all the necessary packages specified in the `requirements.txt` file.\n\n## Running the Project\n\nTo run the project, follow these steps:\n\n1. Open a terminal or command prompt.\n2. Navigate to the root directory of the project.\n3. Run the following command to execute the `main.py` script:\n\n```python\npython src/main.py\n```\nThis command will generate the folder icons based on the specified configuration.\n\n## Running Tests\n\nTo run the project tests, follow these steps:\n\n1. Open a terminal or command prompt.\n2. Navigate to the root directory of the project.\n3. Run the following command to execute the tests:\n\n```python\npytest\n```\n\nThis command will run all the tests located in the `tests` directory.\n\n## Generating Documentation\n\nTo generate the documentation, follow these steps:\n\n1. Open a terminal or command prompt.\n2. Navigate to the root directory of the project.\n3. Run the following command to execute the `generate_readme.py` script:\n\n```python\npython src/generate_readme.py\n```\n\nThis command will generate the `index.md` file in the `docs` directory.\n\n## License\n\n### Mask Images Attribution\nPlease refer to `docs/ATTRIBUTION.md` for full list\n\n### Icon and Image License\n\n- Applies to all `.png`, `.icns`, and `.ico` files in the `icons` directory.\n- License: [MIT License](./LICENSE)\n\n### Brand Images\n\n- All brand icons are trademarks of their respective owners.\n- The use of these trademarks does not indicate endorsement of the trademark holder by OS Folder Icons (Amin Shariati and Sarah Ghanbarzadeh), nor vice versa.\n- Brand icons should only be used to represent the company or product to which they refer.\n- Please do not use brand logos for any purpose except to represent that particular brand or service.\n\n","funding_links":["https://github.com/sponsors/shariati","https://github.com/sponsors/sarah8131","https://ko-fi.com/shariati","https://ko-fi.com/S6S2QRA2Y"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshariati%2FOS-Folder-Icons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshariati%2FOS-Folder-Icons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshariati%2FOS-Folder-Icons/lists"}