|
16 | 16 |
|
17 | 17 | <br> |
18 | 18 |
|
19 | | -# Content |
20 | | -- [About](https://github.com/vikdevelop/SaveDesktop?tab=readme-ov-file#about) |
21 | | - - [Supported environments](https://github.com/vikdevelop/SaveDesktop?tab=readme-ov-file#supported-environments) |
22 | | - - [SaveDesktop features](https://github.com/vikdevelop/SaveDesktop?tab=readme-ov-file#savedesktop-can-save) |
23 | | -- [Contributing](https://github.com/vikdevelop/SaveDesktop?tab=readme-ov-file#contributing) |
24 | | - - [Translations](https://github.com/vikdevelop/SaveDesktop?tab=readme-ov-file#translations) |
25 | | - - [Reporting issues](https://github.com/vikdevelop/SaveDesktop?tab=readme-ov-file#reporting-issues) |
26 | | -- [Installation](https://github.com/vikdevelop/SaveDesktop?tab=readme-ov-file#installation) |
27 | | - |
28 | | -## About |
| 19 | +# About |
| 20 | + |
| 21 | + |
| 22 | +<details> |
| 23 | + <summary><h2>Features</h2><p>Supported desktop environments, range of items to be stored and used configuration directories</p></summary> |
| 24 | + |
| 25 | + |
29 | 26 | ### Supported environments: |
30 | 27 | - GNOME |
31 | 28 | - Xfce |
|
49 | 46 | NOTE: It can happen that a backup file will not be created, in that case, just allow access to the folder in the [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal) app. |
50 | 47 |
|
51 | 48 | <details> |
52 | | - <summary><b>Configuration directories that will be included in the archive</b></summary> |
53 | | - |
54 | | - - **General directories** |
55 | | - ``` |
56 | | - - ~/.config/dconf |
57 | | - - ~/.local/share/backgrounds |
58 | | - - ~/.themes |
59 | | - - ~/.icons |
60 | | - - ~/.local/share/icons |
61 | | - - ~/.local/share/fonts |
62 | | - - ~/.fonts |
63 | | - - ~/.config/gtk-4.0 |
64 | | - - ~/.config/gtk-3.0 |
65 | | - - ~/.var/app |
66 | | - - ~/.local/share/flatpak/app |
67 | | - - /var/lib/flatpak/app |
68 | | - ``` |
69 | | - - **GNOME** |
70 | | - ``` |
71 | | - - ~/.local/share/gnome-background-properties |
72 | | - - ~/.local/share/gnome-shell |
73 | | - - ~/.local/share/nautilus-python |
74 | | - - ~/.local/share/nautilus |
75 | | - - ~/.local/share/gnome-control-center |
76 | | - ``` |
77 | | - - **Pantheon** |
78 | | - ``` |
79 | | - - ~/.config/plank |
80 | | - - ~/.config/marlin |
81 | | - ``` |
82 | | - - **Cinnamon** |
83 | | - ``` |
84 | | - - ~/.config/nemo |
85 | | - - ~/.local/share/cinnamon |
86 | | - - ~/.cinnamon |
87 | | - ``` |
88 | | - - **Budgie** |
89 | | - ``` |
90 | | - - ~/.config/budgie-desktop |
91 | | - - ~/.config/bugie-extras |
92 | | - - ~/.config/nemo |
93 | | - ``` |
94 | | - - **Cosmic (Old)** |
95 | | - ``` |
96 | | - - ~/.config/pop-shell |
97 | | - - ~/.local/share/gnome-shell |
98 | | - ``` |
99 | | - - **Cosmic (New)** |
100 | | - ``` |
101 | | - - ~/.config/cosmic |
102 | | - - ~/.local/state/cosmic |
103 | | - ``` |
104 | | - - **Xfce** |
105 | | - ``` |
106 | | - - ~/.config/xfce4 |
107 | | - - ~/.config/Thunar |
108 | | - - ~/.xfce4 |
109 | | - ``` |
110 | | - - **MATE** |
111 | | - ``` |
112 | | - - ~/.config/caja |
113 | | - ``` |
114 | | - - **KDE Plasma** |
115 | | - ``` |
116 | | - - ~/.config/[k]* (all directories and files beginning with k) |
117 | | - - ~/.config/gtkrc |
118 | | - - ~/.config/dolphinrc |
119 | | - - ~/.config/gwenviewrc |
120 | | - - ~/.config/plasmashellrc |
121 | | - - ~/.config/spectaclerc |
122 | | - - ~/.config/plasmarc |
123 | | - - ~/.config/plasma-org.kde.plasma.desktop-appletsrc |
124 | | - - ~/.local/share/[k]* (all directories and files beginning with k) |
125 | | - - ~/.local/share/konsole |
126 | | - - ~/.local/share/dolphin |
127 | | - - ~/.local/share/sddm |
128 | | - - ~/.local/share/wallpapers |
129 | | - - ~/.local/share/plasma-systemmonitor |
130 | | - - ~/.local/share/plasma |
131 | | - - ~/.local/share/aurorae |
132 | | - - ~/.local/share/kscreen |
133 | | - - ~/.local/share/color-schemes |
134 | | - ``` |
135 | | - - **Deepin** |
136 | | - ``` |
137 | | - - ~/.config/deepin |
138 | | - - ~/.local/share/deepin |
139 | | - ``` |
140 | | - - **Hyprland** |
141 | | - ``` |
142 | | - - ~/.config/hypr |
143 | | - ``` |
144 | | - |
| 49 | + <summary><b>Configuration directories that will be included in the archive</b></summary> |
| 50 | + |
| 51 | + - **General directories** |
| 52 | + ``` |
| 53 | + - ~/.config/dconf |
| 54 | + - ~/.local/share/backgrounds |
| 55 | + - ~/.themes |
| 56 | + - ~/.icons |
| 57 | + - ~/.local/share/icons |
| 58 | + - ~/.local/share/fonts |
| 59 | + - ~/.fonts |
| 60 | + - ~/.config/gtk-4.0 |
| 61 | + - ~/.config/gtk-3.0 |
| 62 | + - ~/.var/app |
| 63 | + - ~/.local/share/flatpak/app |
| 64 | + - /var/lib/flatpak/app |
| 65 | + ``` |
| 66 | + - **GNOME** |
| 67 | + ``` |
| 68 | + - ~/.local/share/gnome-background-properties |
| 69 | + - ~/.local/share/gnome-shell |
| 70 | + - ~/.local/share/nautilus-python |
| 71 | + - ~/.local/share/nautilus |
| 72 | + - ~/.local/share/gnome-control-center |
| 73 | + ``` |
| 74 | + - **Pantheon** |
| 75 | + ``` |
| 76 | + - ~/.config/plank |
| 77 | + - ~/.config/marlin |
| 78 | + ``` |
| 79 | + - **Cinnamon** |
| 80 | + ``` |
| 81 | + - ~/.config/nemo |
| 82 | + - ~/.local/share/cinnamon |
| 83 | + - ~/.cinnamon |
| 84 | + ``` |
| 85 | + - **Budgie** |
| 86 | + ``` |
| 87 | + - ~/.config/budgie-desktop |
| 88 | + - ~/.config/bugie-extras |
| 89 | + - ~/.config/nemo |
| 90 | + ``` |
| 91 | + - **Cosmic (Old)** |
| 92 | + ``` |
| 93 | + - ~/.config/pop-shell |
| 94 | + - ~/.local/share/gnome-shell |
| 95 | + ``` |
| 96 | + - **Cosmic (New)** |
| 97 | + ``` |
| 98 | + - ~/.config/cosmic |
| 99 | + - ~/.local/state/cosmic |
| 100 | + ``` |
| 101 | + - **Xfce** |
| 102 | + ``` |
| 103 | + - ~/.config/xfce4 |
| 104 | + - ~/.config/Thunar |
| 105 | + - ~/.xfce4 |
| 106 | + ``` |
| 107 | + - **MATE** |
| 108 | + ``` |
| 109 | + - ~/.config/caja |
| 110 | + ``` |
| 111 | + - **KDE Plasma** |
| 112 | + ``` |
| 113 | + - ~/.config/[k]* (all directories and files beginning with k) |
| 114 | + - ~/.config/gtkrc |
| 115 | + - ~/.config/dolphinrc |
| 116 | + - ~/.config/gwenviewrc |
| 117 | + - ~/.config/plasmashellrc |
| 118 | + - ~/.config/spectaclerc |
| 119 | + - ~/.config/plasmarc |
| 120 | + - ~/.config/plasma-org.kde.plasma.desktop-appletsrc |
| 121 | + - ~/.local/share/[k]* (all directories and files beginning with k) |
| 122 | + - ~/.local/share/konsole |
| 123 | + - ~/.local/share/dolphin |
| 124 | + - ~/.local/share/sddm |
| 125 | + - ~/.local/share/wallpapers |
| 126 | + - ~/.local/share/plasma-systemmonitor |
| 127 | + - ~/.local/share/plasma |
| 128 | + - ~/.local/share/aurorae |
| 129 | + - ~/.local/share/kscreen |
| 130 | + - ~/.local/share/color-schemes |
| 131 | + ``` |
| 132 | + - **Deepin** |
| 133 | + ``` |
| 134 | + - ~/.config/deepin |
| 135 | + - ~/.local/share/deepin |
| 136 | + ``` |
| 137 | + - **Hyprland** |
| 138 | + ``` |
| 139 | + - ~/.config/hypr |
| 140 | + ``` |
| 141 | + |
| 142 | +</details> |
| 143 | + |
145 | 144 | </details> |
146 | 145 |
|
147 | | -## Contributing |
148 | | -*See to the [CONTRIBUTING.md](https://github.com/vikdevelop/SaveDesktop/blob/main/CONTRIBUTING.md) for more information.* |
149 | | - |
150 | | -### Translations |
151 | | -If you want to help localize SaveDesktop, you can use the Weblate tool (it is possible to register with, e.g., GitHub or Google). |
152 | | -| <h4>SaveDesktop application</h4> (click on widget below) | <h4>SaveDesktop Github wiki</h4> (click on widget below) | |
153 | | -| --- | --- | |
154 | | -| <a href="https://hosted.weblate.org/projects/vikdevelop/savedesktop/"><img src="https://hosted.weblate.org/widget/vikdevelop/savedesktop/287x66-grey.png" alt="Stav překladu" /></a> | <a href="https://hosted.weblate.org/projects/vikdevelop/savedesktop-github-wiki/"><img src="https://hosted.weblate.org/widget/vikdevelop/savedesktop-github-wiki/287x66-grey.png" alt="Stav překladu" /></a> | |
155 | | - |
156 | | -### Reporting issues |
157 | | -You can report an issue on GitHub, or if you are not registered on GitHub, you can use this [web page](https://vikdevelop.github.io/SaveDesktop/open-issue/). You can also use [Github Discussions](https://github.com/vikdevelop/SaveDesktop/discussions). |
| 146 | +<details> |
| 147 | + <summary><h2>Installation</h2><p>Installation of stable or beta releases</p></summary> |
| 148 | + |
158 | 149 |
|
159 | | -## Installation |
160 | 150 | ### Stable releases |
161 | 151 | - Flathub |
162 | 152 |
|
@@ -203,3 +193,31 @@ Then, you can continue in building this app using Flatpak Builder by entering th |
203 | 193 | ``` |
204 | 194 | git clone https://github.com/vikdevelop/SaveDesktop && cd SaveDesktop && flatpak-builder build *.yaml --install --user |
205 | 195 | ``` |
| 196 | + |
| 197 | +</details> |
| 198 | + |
| 199 | + |
| 200 | +<details> |
| 201 | + <summary><h2>Contribution</h2><p>Translations, reporting issues, contributing and code of conduct</p></summary> |
| 202 | + |
| 203 | + |
| 204 | +### Code of Conduct |
| 205 | + |
| 206 | +This project follows the GNOME Code of Conduct available at: |
| 207 | +https://conduct.gnome.org |
| 208 | + |
| 209 | +By participating, you are expected to uphold this code. |
| 210 | + |
| 211 | +### Contributing |
| 212 | +*See to the [CONTRIBUTING.md](https://github.com/vikdevelop/SaveDesktop/blob/main/CONTRIBUTING.md) for more information.* |
| 213 | + |
| 214 | +#### Translations |
| 215 | +If you want to help localize SaveDesktop, you can use the Weblate tool (it is possible to register with, e.g., GitHub or Google). |
| 216 | +| <h4>SaveDesktop application</h4> (click on widget below) | <h4>SaveDesktop Github wiki</h4> (click on widget below) | |
| 217 | +| --- | --- | |
| 218 | +| <a href="https://hosted.weblate.org/projects/vikdevelop/savedesktop/"><img src="https://hosted.weblate.org/widget/vikdevelop/savedesktop/287x66-grey.png" alt="Stav překladu" /></a> | <a href="https://hosted.weblate.org/projects/vikdevelop/savedesktop-github-wiki/"><img src="https://hosted.weblate.org/widget/vikdevelop/savedesktop-github-wiki/287x66-grey.png" alt="Stav překladu" /></a> | |
| 219 | + |
| 220 | +#### Reporting issues |
| 221 | +You can report an issue on GitHub, or if you are not registered on GitHub, you can use this [web page](https://vikdevelop.github.io/SaveDesktop/open-issue/). You can also use [Github Discussions](https://github.com/vikdevelop/SaveDesktop/discussions). |
| 222 | + |
| 223 | +</details> |
0 commit comments