diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6eaa2fe --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Welcome to GitHub docs contributing guide + +Thank you for investing your time in contributing to our project! :sparkles:. + +## New contributor guide + +To get an overview of the project, read the [README](README.md). + +## Getting started + +Project structure: +``` +. +├── assets - assets for creating background images +| ├── background_template - Photoshop project file for creating background image +| ├── icons - icons that gets copied to icons folder in every theme +| └── preview_template - Photoshop project file for creating preview image +├── customize - non-compressed themes +├── font - fonts used in each theme +├── preview - preview images for Github repository +└── themes - compressed themes ready to install in .tar format +```