| 1 | ## CORE Icons  
|
| 2 |
|
| 3 | A set of SVGs turned into a web compatible `@font-face`.
|
| 4 |
|
| 5 | ## Requirements
|
| 6 |
|
| 7 | Node 6+
|
| 8 | NPM or Yarn
|
| 9 |
|
| 10 | ## Developing
|
| 11 |
|
| 12 | To get started, type the following from the root directory:
|
| 13 |
|
| 14 | ```
|
| 15 | yarn
|
| 16 | yarn dev
|
| 17 | ```
|
| 18 |
|
| 19 | ## Building
|
| 20 |
|
| 21 | ```
|
| 22 | yarn build
|
| 23 | ```
|
| 24 |
|
| 25 | # Updating Icons from Figma
|
| 26 |
|
| 27 | 1. Clone the repo
|
| 28 |
|
| 29 | 2. `cd` to project folder root
|
| 30 |
|
| 31 | 3. Set the `FIGMA_TOKEN` and `GH_TOKEN` env variables in the `.env` file. You can get these from Figma and Github.
|
| 32 |
|
| 33 | 4. Run the command `node scripts/update_icons_from_figma.js`
|
| 34 |
|
| 35 | 5. Commit and open a pull request with the updated icons.
|
| 36 |
|
| 37 | # Updating Icons from IcoMoon (Deprecated)
|
| 38 |
|
| 39 | ~~## Updating in [IcoMoon](https://icomoon.io/)~~
|
| 40 |
|
| 41 | ~~1. Name icons according to the following naming convention:~~
|
| 42 |
|
| 43 | ```
|
| 44 | tool-?[name]-[shape]-[o]-[direction]
|
| 45 | ```
|
| 46 |
|
| 47 | ~~2. Select the entire font set and select "Generate Font"~~
|
| 48 |
|
| 49 | ~~3. Download the font archive~~
|
| 50 |
|
| 51 | ~~4. If icons have not yet been updated in the current prerelease, the `src/selection-old.json` file must be replaced with the `src/selection.json`. Otherwise nothing needs to be done on this step.~~
|
| 52 |
|
| 53 | ~~5. Extract the downloaded font archive contents into the `src` folder, overwriting the existing files.~~
|
| 54 |
|
| 55 | ~~6. Check on localhost that the icons appear on the Icons docs~~
|
| 56 |
|
| 57 | ## Contributing
|
| 58 |
|
| 59 | Bug reports and pull requests are welcome on GitHub at https://github.com/procore/core. This project is
|
| 60 | intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
|
| 61 | [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
| 62 |
|
| 63 | ## License
|
| 64 |
|
| 65 | The package is available under the [Procore Developers License](https://developers.procore.com/terms_and_conditions)
|
| 66 |
|
| 67 | ## About Procore
|
| 68 |
|
| 69 | <img
|
| 70 | src="https://www.procore.com/images/procore_logo.png"
|
| 71 | alt="Procore Logo"
|
| 72 | width="250px"
|
| 73 | />
|
| 74 |
|
| 75 | CORE Icons is maintained by Procore Technologies.
|
| 76 |
|
| 77 | Procore - building the software that builds the world.
|
| 78 |
|
| 79 | Learn more about the #1 most widely used construction management software at [procore.com](https://www.procore.com/)
|