Grub-Themes/docs/Contributing.mdx
2023-05-31 20:34:18 +02:00

71 lines
3 KiB
Text

# Contributing guide
Thank you for investing your time in contributing to this project! :sparkles:.
## New contributor guide
To get an overview of the project, read the [README](README.md) and [wiki page](https://github.com/AdisonCavani/distro-grub-themes/wiki).
### Project structure:
```
.
├── assets - assets for creating background images
| ├── backgrounds - backgrounds used in each theme
| ├── fonts - fonts
| ├── icons - icons
| ├── menu - menu parts
| └── theme.txt - theme configuration file
├── docs - documentation markdown files
├── preview - preview images for README.md
├── themes - compressed themes ready to install in .tar format
└── themes.json - json file containing all themes definitions (used as database for wiki page)
```
### Workflow
Folders that trigger new action/workflow:
- assets
- customize
Every time you create new commit on master branch, github action bot will update all files (as defined in [this file](https://github.com/AdisonCavani/distro-grub-themes/blob/master/.github/workflows/update-content.yml)).
You can track your workflows [here](https://github.com/AdisonCavani/distro-grub-themes/actions).
### Branches
```
├── master - main branch containing latest changes
├── legacy - obsolete C# program, replaced by Github Actions workflow
└── templates - PSD, phosothop templates for background images
```
### Frequently Asked Questions
**Q**: Where are `psd` templates located?
**A**: Templates are located in [`templates branch`](https://github.com/AdisonCavani/distro-grub-themes/tree/templates).
**Q**: How can I edit `psd` template? I don't have Photoshop
**A**: You can import `psd` into GIMP, however this might cause to lose some Photoshop related data. I recommend to use [Photopea](https://www.photopea.com/) - free web-based Photoshop alternative.
<JsonLd content={{
"@context": "https://schema.org",
"@type": "FAQPage",
mainEntity: [
{
"@type": "Question",
name: "Where are psd templates located?",
acceptedAnswer: {
"@type": "Answer",
text: "Templates are located in &lt;a href=&apos;https://github.com/AdisonCavani/distro-grub-themes/tree/templates&apos;&gt;templates branch&lt;/a&gt;.",
},
},
{
"@type": "Question",
name: "How can I edit psd template? I don&apos;t have Photoshop.",
acceptedAnswer: {
"@type": "Answer",
text: "You can import psd into GIMP, however this might cause to lose some Photoshop related data. I recommend to use &lt;a href=&apos;https://www.photopea.com/&apos;&gt;Photopea&lt;/a&gt; - free web-based Photoshop alternative.",
},
},
],
}}/>