README.md 1.73 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 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

BUILD
-----
The only build-time dependency is [meson](http://mesonbuild.com/).

    meson builddir
    ninja -C builddir
    ninja -C builddir install

RUNTIME DEPENDENCIES
--------------------
* Python3
* pygobject (>= 3.10)
* gnome-settings-daemon

* GIR files and libraries from:
  - GLib
  - GTK+ 3 (>= 3.12)
  - gnome-desktop
  - libsoup
  - libnotify
  - Pango

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

* Optional:
   - gnome-software (for links from GNOME Shell Extensions page)

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

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

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

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

53 54 55 56 57 58 59 60 61 62 63 64
HOMEPAGE
--------
https://wiki.gnome.org/Apps/GnomeTweakTool

DEVELOPMENT REPOSITORY
----------------------
https://git.gnome.org/browse/gnome-tweak-tool

BUGS
----
https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-tweak-tool

65
https://bugzilla.gnome.org/buglist.cgi?quicksearch=product%3Agnome-tweak-tool
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.

73
data/org.gnome.tweaks.appdata.xml.in is licensed under the Creative Commons
74
CC0-1.0 license.