Skip to content
Update How to contribute to EOS icons authored by Kenneth Wimer's avatar Kenneth Wimer
......@@ -17,18 +17,18 @@ In an ideal world, the `dist` folder would be ignored and built at runtime by th
![image](uploads/0438d408c6014ae8b22821f91edc9202/image.png)
- **.git:** By default ignored by GIT, it is the folder where GIT will save all the relevant information about branches, commit history, etc.
- **.git:** By default ignored by GIT, this is the folder where GIT will save all relevant information about branches, commit history, etc.
- **animated:** This folder contains the SCSS files to create animated icons for EOS-icons.
- **dist:** This folder contains the files that any person downloading EOS-icons would need, plus the demo page.
- **svg:** This folder contains only SVG files. In the root of the folder, you will find all the EOS-icons files, while the `/extended` subfolder contains all the SVG icons coming from Material Icons (https://material.io/tools/icons/). You should never modify the content of the `/extended` folder since it is also generated on build time by `grunt`.
- **svg:** This folder contains only SVG files. In the root of the folder, you will find all the EOS-icons files, while the `/extended` subfolder contains all the SVG icons from the Material Icons (https://material.io/tools/icons/). You should never modify the content of the `/extended` folder because it is generated during the build by `grunt`.
- **templates:** This is the main folder that contains the files for the demo page. Let's make a bigger abstraction here:
- ![image](uploads/2ed99327e5d39c9cf82738ed775c2924/image.png)
- The first 2 files you see are ignored in `.gitignore` because they are generated by `grunt` too.
- The first 2 files you see are ignored in `.gitignore` because they are generated by `grunt` as well.
- **css-webfont.css:** This file is the template that `grunt` uses to create the distribution file for the font implementation. You should not add classes relevant to the website UI in this file. DONT MODIFY.
- **glyph-list-template.json:** This is another template used by `grunt` and which will generate a json file with the complete list of EOS-icons reading from the `svg` folder. DONT MODIFY.
- **index-template-extended.html:** This file contains the html for the demo page of the **extended font** https://eos-icons.eosdesignsystem.com/extended/index.html (EOS-icons + Material Icons.. all in one). You can edit this file.
- **index-template.html:** This file contains the html for the main demo page https://eos-icons.eosdesignsystem.com/. You can edit this file.
- **glyph-list-template.json:** This is another template used by `grunt` which will generate a json file with the complete list of EOS-icons, reading from the `svg` folder. DONT MODIFY.
- **index-template-extended.html:** This file contains the html for the demo page of the **extended font** https://eos-icons.eosdesignsystem.com/extended/index.html (EOS-icons + Material Icons.. all in one). You may edit this file.
- **index-template.html:** This file contains the html for the main demo page https://eos-icons.eosdesignsystem.com/. You may edit this file.
- **index.css:** This file contains the CSS for both of the above mentioned `.html` files. Edit this file to include new classes for the demo pages.
- **logo.png:** Is the EOS logo, which will be shown in the demo pages.
- **logo.png:** Is the EOS logo, which is shown in the demo pages.
The rest of the files in the `root` of the repository are responsible for the server to run, build, and deploy. You shouldn't touch any of those files unless you know what you are doing.
\ No newline at end of file