README.md 1.78 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)
24 25 26 27 28
  - libsoup
  - libnotify
  - Pango

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

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

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

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

43 44
SUPPORTED DESKTOPS
------------------
Alberto Fanjul's avatar
Alberto Fanjul committed
45 46
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
47

John Stowers's avatar
John Stowers committed
48 49 50 51 52 53
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

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

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

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

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
72 73
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.