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. 'openleadr' ). This must match the slug for the project as defined in LFX PCC, and be all lowercase.

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.png
      <project name>-horizontal-color.svg
    - white
      <project name>-horizontal-white.png
      <project name>-horizontal-white.svg
    - black
      <project name>-horizontal-black.png
      <project name>-horizontal-black.svg
  - stacked
    - color
      <project name>-stacked-color.png
      <project name>-stacked-color.svg
    - white
      <project name>-stacked-white.png
      <project name>-stacked-white.svg
    - black
      <project name>-stacked-black.png
      <project name>-stacked-black.svg
  - icon
    - color
      <project name>-icon-color.png
      <project name>-icon-color.svg
    - white
      <project name>-icon-white.png
      <project name>-icon-white.svg
    - black
      <project name>-icon-black.png
      <project name>-icon-black.svg

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...

---
title: <project full name> 
featured_image: <relative path to the image to show on the home page>
---