diff --git a/README.md b/README.md index 9234774e2..ee007c249 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,12 @@ # Simple Icons -## Build Process +## Want to contribute? -1. Acquire source vector file. -1. Simplify icon in vector editing tool (I use [Affinity Designer](https://affinity.serif.com/en-gb/)). - - Constrain within a 16x16 viewbox. - - Ensure there are no strokes. - - Simplify and minimise paths. - - Make all paths white. -1. Export SVG. -1. Run SVGO on the SVG file. -1. Add object to [simple-icons.json](https://github.com/danleech/simple-icons/blob/gh-pages/src/simple-icons.json). -1. Run [build.js](https://github.com/danleech/simple-icons/blob/gh-pages/src/build.js) in Node. +1. Find an official source vector image. +2. Use your SVG editor of choice to produce a monochrome icon (with a view to keeping the file size as small as possible). +3. Optimize the SVG using SVGO and add it to the `/icons` directory. +4. Add an entry to `/src/simple-icons.json` with: + - The icon title + - The HEX colour value + - The URL of the source vector image (or the page it’s available at) \ No newline at end of file