You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
4. **Make your changes**: Implement your feature or bug fix.
17
+
5. **Commit your changes**:
18
+
```sh
19
+
git commit -m "Description of your changes"
20
+
```
21
+
6. **Push to your fork**:
22
+
```sh
23
+
git push origin your-branch-name
24
+
```
25
+
7. **Create a Pull Request**: Go to the original repository and click "New Pull Request".
26
+
27
+
## Reporting Issues
28
+
29
+
If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible to help us understand and address the issue.
30
+
31
+
## Adding a Theme
32
+
33
+
To add a theme, you need to modify three files:
34
+
35
+
- [index.html](index.html)
36
+
- [themes.json](./assets/themes.json)
37
+
- [README.md](README.md)
38
+
39
+
### Changes in index.html
40
+
41
+
Follow the `<!-- For Developers:` comments.
42
+
43
+
### Changes in themes.json
44
+
45
+
[themes.json](./assets/themes.json) contains a JS object that has the following structure:
46
+
47
+
```js
48
+
{
49
+
"Theme": [
50
+
r,g,b,
51
+
r,g,b,
52
+
r,g,b,
53
+
...
54
+
r,g,b
55
+
],
56
+
...
57
+
"Theme": [
58
+
r,g,b,
59
+
r,g,b,
60
+
...
61
+
r,g,b
62
+
]
63
+
}
64
+
```
65
+
66
+
Each r,g, and b value is stored one after another in an array of integers, where r,g,b represents one colour of the theme.
67
+
68
+
Please ensure that the order remains the same as listed in index.html. Add your palette in r,g,b values.
69
+
70
+
### Changes in README.md
71
+
72
+
Please add the theme name in the README with a link to the GitHub repository of the theme.
73
+
74
+
## Contributing Elsewhere
75
+
76
+
Feel free to modify whatever you'd like in addition to adding themes. Styling, changing the layout, optimizing JS, etc. is welcome. Please ensure that you explain these kinds of changes in detail when opening a PR.
Inspired by [Gruvbox Factory](https://github.com/paulopacitti/gruvbox-factory) and [ImageGoNord](https://github.com/Schrodinger-Hat/ImageGoNord)
@@ -20,15 +25,31 @@ Inspired by [Gruvbox Factory](https://github.com/paulopacitti/gruvbox-factory) a
20
25
21
26
22
27
28
+
Note: There are more themes than just the ones listed here.
29
+
23
30
## Instructions
24
31
25
32
1. Drag/Drop an image or click on "Browse" to select your image.
26
33
2. Select a theme.
27
-
3. If you want to do a custom theme, select "Custom Theme" and press the + button to add colours. Click on the colour swatch (the black block with the white outline) and change the colour to whatever you'd like. Press "Done" when you are ready.
34
+
3. If you want to do a custom theme, select "Custom Theme" and press the + button to add colours. Click on the colour swatch (the black block) and change the colour to whatever you'd like. Press "Done" when you are ready.
28
35
4. Press "Convert"
29
-
5. Wait!! It may take a few seconds, especially if you have lower-end hardware. You will know that it is done when you see the "Download" button and "Reset Image" button.
36
+
5. Wait! It may take a few seconds, especially if you have lower-end hardware. You will know that it is done when you see the "Download" button and "Reset Image" button.
30
37
6. Download the image if you'd like, or if you want to try another palette, press "Reset Image" and repeat steps 3-5.
31
38
32
39
## How it works
33
40
34
-
I wrote a blog post in 2022 explaining more about how it works. Check it out: https://notneelpatel.github.io/blog/2022-05-10-wallpaper-theme-converter.html
41
+
I wrote a blog post in 2022 explaining more about how it works. Check it out: [https://notneelpatel.github.io/blog/2022-05-10-wallpaper-theme-converter.html](https://notneelpatel.github.io/blog/2022-05-10-wallpaper-theme-converter.html)
42
+
43
+
## Contributors
44
+
45
+
Thank you to all of the contributers! You can find the contributor list [here](https://github.com/NotNeelPatel/WallpaperThemeConverter/graphs/contributors)
46
+
47
+
If you would like to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md)
48
+
49
+
## Self-Hosting/Running Locally
50
+
51
+
In the event that you would like to host Wallpaper Theme Converter or run locally for development purposes, you can do so very easily as there are no JS dependencies or libraries for this website. This is a pure HTML + CSS + JS implementation. Simply clone this repository and open `index.html`.
52
+
53
+
## License
54
+
55
+
This project is under an [MIT License](LICENSE). I would appreciate it if you could credit me and/or provide a link to this GitHub repository.
0 commit comments