INSTRUCTIONS.md

How to add new project artwork

<project full name> is the display name for the project ( e.g. 'OpenEXR' )

<project name> is the name of the project in the filesystem ( e.g. 'openexr' )

1. Add a new directory under projects with the artwork. Artwork directory structure should map as follows...

<project name>
  - horizontal
    - color
      <project name>-horizontal-color.svg
      <project name>-horizontal-color.png
    - white
      <project name>-horizontal-white.svg
      <project name>-horizontal-white.png
    - black
      <project name>-horizontal-black.svg
      <project name>-horizontal-black.png
  - stacked
    - color
      <project name>-stacked-color.svg
      <project name>-stacked-color.png
    - white
      <project name>-stacked-white.svg
      <project name>-stacked-white.png
    - black
      <project name>-stacked-black.svg
      <project name>-stacked-black.png
  - icon
    - color
      <project name>-icon-color.svg
      <project name>-icon-color.png
    - white
      <project name>-icon-white.svg
      <project name>-icon-white.png
    - black
      <project name>-icon-black.svg
      <project name>-icon-black.png

If you are using the GitHub web client, the easiest thing to do is create the folder structure on your local machine, and then go to the projects directory and follow the instructions for uploading a folder/file to the repository

2. Create README.md under <project name> directory. Contents should match this typically...

---
description: Artwork for the <project full name> project
title: <project full name> 
level: <project level: match string on home page> 
featured_image: <relative path to the image to show on the home page> 
layout: logos
---