README.md 1.8 KB
Newer Older
Alberto Fanjul's avatar
Alberto Fanjul committed
1
GNOME TWEAKS
2
================
John Stowers's avatar
John Stowers committed
3

4
5
6

BUILD
-----
Jeremy Bicha's avatar
Jeremy Bicha committed
7
The only build-time dependency is [meson](https://mesonbuild.com/).
8
9
10
11
12
13
14
15
16
17

    meson builddir
    ninja -C builddir
    ninja -C builddir install

RUNTIME DEPENDENCIES
--------------------
* Python3
* pygobject (>= 3.10)
* gnome-settings-daemon
18
* sound-theme-freedesktop
19
20

* GIR files and libraries from:
21
  - GLib (>= 2.58)
22
  - GTK+ 3 (>= 3.12)
23
  - gnome-desktop (>= 3.30)
Xi Ruoyao's avatar
Xi Ruoyao committed
24
  - libhandy (>= 1.0)
25
26
27
28
29
  - libsoup
  - libnotify
  - Pango

* GSettings Schemas from:
30
  - gsettings-desktop-schemas (>= 3.33.0)
31
  - gnome-shell (>= 3.24)
32
33
34
35
  - mutter

* Optional:
   - gnome-software (for links from GNOME Shell Extensions page)
36
   - nautilus 3.26 or older (for icons on the desktop)
37
38

RUNNING
John Stowers's avatar
John Stowers committed
39
-------
John Stowers's avatar
John Stowers committed
40
41
 * If you wish to run the application uninstalled, execute;

42
    ./gnome-tweaks [-p /path/to/jhbuild/prefix/]
John Stowers's avatar
John Stowers committed
43

44
45
SUPPORTED DESKTOPS
------------------
Alberto Fanjul's avatar
Alberto Fanjul committed
46
47
Tweaks is designed for GNOME Shell but can be used in other desktops.
A few features will be missing when Tweaks is run on a different desktop.
John Stowers's avatar
John Stowers committed
48

John Stowers's avatar
John Stowers committed
49
50
51
52
53
54
TODO
----
 * I'm not sure if the TweakGroup layer is necessary, and it makes
   it hard to categorise things. Perhaps go to a named factory approach
 * Do some more things lazily to improve startup speed

55
56
HOMEPAGE
--------
57
https://wiki.gnome.org/Apps/Tweaks
58
59
60

DEVELOPMENT REPOSITORY
----------------------
61
https://gitlab.gnome.org/GNOME/gnome-tweaks
62
63
64

BUGS
----
65
https://gitlab.gnome.org/GNOME/gnome-tweaks/issues
66
67
68
69
70
71
72

LICENSE
-------
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.

Jeremy Bicha's avatar
Jeremy Bicha committed
73
74
data/org.gnome.tweaks.appdata.xml.in is licensed under the [Creative Commons
CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode) license.