README.md in ethosstyles-0.1.18 vs README.md in ethosstyles-0.1.19

- old
+ new

@@ -22,13 +22,13 @@ Develop new elements for Moonbeam in `moonbeam/app/assets/stylesheets/components/_rf-for-gem.scss`. - Prefix new styles with `.rf-` - Make sure new styles are [BEM-ified](https://csswizardry.com/2013/01/mindbemding-getting-your-head-round-bem-syntax/) 3. **Port new elements to Stardust repo**: - - **Goal**: Add styles to Stardust and demonstrate their intended use. - + + **Goal**: Add styles to Stardust and demonstrate their intended use. + Involved files: - `app/assets/stylesheets/components/<new-element>.scss` - Copy the styles directly from `_rf-for-gem.scss` in Moonbeam and paste them here. Your code here must match what is in `_rf-for-gem.scss`. - Demonstrate suggested use with HTML in the comments. For example, from [\_tables.scss](https://git.corp.adobe.com/adobe-platform/stardust/blob/master/app/assets/stylesheets/components/_tables.scss): ``` @@ -54,15 +54,15 @@ // // Best Practices // // Set column widths in the header // - ``` + ``` - `index.php`: Add a new section to the display page for the new element - `app/views/`: - - `<new-element>.php` + - `<new-element>.php` Create new section for the new element - `partial_<new-element>.php`: Use to prevent repetitive code - `app/assets/stylesheets/_ethosstyles.scss` - Add an `@import` statement for the new element's stylesheet @@ -77,22 +77,22 @@ docker rm -f $(docker ps -a|grep -v moonbeam_db|grep -v CONTAINER|awk '{print $1}') docker start moonbeam_db flotilla up moonbeam ``` - - Force a recompiling of the scss elements by editing `application.scss` (for example, add `body {background-color: yellow;}` and save). + - Force a recompiling of the scss elements by editing `application.scss` (for example, add `body {background-color: yellow;}` and save). -5. **Update Moonbeam** +5. **Update Moonbeam** - **Goal**: Styles are sourced solely from Stardust GEM. - + **Goal**: Styles are sourced solely from Stardust GEM. + Remove redundant code from: - Outdated Moonbeam stylehseets - `_rf-for-gem.scss` - + ## To edit gem To develop this gem locally: 1. Clone this repo to your computer. @@ -115,5 +115,9 @@ ## Process **Review any changes on Moonbeam and OrCA before pushing to [prod](https://rubygems.org/gems/ethosstyles).** + +## Dependencies + +Stardust uses the .scss icon files from [Font Awesome 5.6.3](https://fontawesome.com/changelog/latest)