Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 2.04 KB

contribute.md

File metadata and controls

40 lines (27 loc) · 2.04 KB
Raw

Contributing

Developing icon sets

Creating icons for OpenCanopy is actually quite simple. Once you've ensured that you've created your desired images according to OpenCore's recommended specification, you can use OpenCore's bundled icnspack(Under Utilities/icnspack) to convert .png's to supported .icons:

# Example usage
./icnspack icon-x1.png icon-x2.png

Additionally, chris1111 has created a great tool for users to create their own icon sets:

Contributing a media set

To contribute a media set to OpenCanopy gallery, we recommend taking a peak at how our site is handled on Github. A basic technical break down is as follows:

  • Pages are written in Markdown
  • Pages are defined by the config.js file
    • Basic understanding of JavaScript recommended to understand how pages are handled
  • Website is both generated and hosted on Github
    • Therefore all changes and adjustments must be done through Pull Requests
    • Backend is built with VuePress

Once you have a basic graps of how the repository works, we recommend users fork and clone the guide locally with a Git Client for easy of use.

To build sites locally, you'll need to run the following workflow (with NPM installed):

# Install required dependancies
npm install
# Build Locally
npm run build

Once you're done making changes, you can create a pull request on our guide and have our team review the changes.