diff options
author | Andre Miranda <andreldm@xfce.org> | 2020-05-18 20:40:27 -0300 |
---|---|---|
committer | Andre Miranda <andreldm@xfce.org> | 2020-05-18 20:40:27 -0300 |
commit | 8ef4bb1bbd83e3ca58a7bc608f9ab068c59d59ac (patch) | |
tree | 3374f2a8fdc34915e844684e18900148cadf25fb | |
parent | 360af77d302fc43663e8b532b91946a8d8e43510 (diff) | |
download | xfdesktop-8ef4bb1bbd83e3ca58a7bc608f9ab068c59d59ac.tar.gz |
Switch to README.md and foreign automake mode
-rw-r--r-- | Makefile.am | 1 | ||||
-rw-r--r-- | README | 104 | ||||
-rw-r--r-- | README.md | 48 | ||||
-rw-r--r-- | configure.ac.in | 2 |
4 files changed, 50 insertions, 105 deletions
diff --git a/Makefile.am b/Makefile.am index 249e87f8..d71cda1e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -15,6 +15,7 @@ manpagedir = $(mandir)/man1 manpage_DATA = xfdesktop.1 EXTRA_DIST = \ + README.md \ TODO \ intltool-extract.in \ intltool-merge.in \ diff --git a/README b/README deleted file mode 100644 index 03b442b6..00000000 --- a/README +++ /dev/null @@ -1,104 +0,0 @@ -README for xfdesktop -================================ - -WHAT IS IT? -~~~~~~~~~~~ - -Xfdesktop is a desktop manager for the Xfce Desktop Environment. Desktop -in this respect means the root window (or, rather, a window that sits on top -of the root window). The manager handles the following tasks: -- background image / color -- root menu, window list -- minimized app icons -- file icons on the desktop (using Thunar libs) - - -MINIMUM REQUIREMENTS -~~~~~~~~~~~~~~~~~~~~ - -* intltool 0.31 -* GTK+ 3.20.0 -* libxfce4util 4.12 -* libxfce4ui 4.13 -* libwnck 3.14 -* libexo 0.11 -* xfconf 4.12.1 -* garcon 0.6.0 (optional; required for apps menu) -* thunar 1.2 (optional; required for file icons) -* tumbler 1.6 (optional; enables thumbnail previews for file icons) -* cairo 1.12 - - -HIDDEN CUSTOMISATIONS -~~~~~~~~~~~~~~~~~~~~~ - -If you're using the icon view, and would like to change how the text looks, -you have three things you can change: the opacity (transparency) of the -rounded text background, the color of the rounded text background, and the -color of the text itself. - -You'd want to add something like this to your ~/.gtkrc-2.0 file: - -style "xfdesktop-icon-view" { - XfdesktopIconView::label-alpha = 75 - XfdesktopIconView::selected-label-alpha = 100 - XfdesktopIconView::ellipsize-icon-labels = 1 - XfdesktopIconView::tooltip-size = 128 - - XfdesktopIconView::shadow-x-offset = 1 - XfdesktopIconView::shadow-y-offset = 1 - XfdesktopIconView::shadow-color = "#ff0000" - XfdesktopIconView::selected-shadow-x-offset = 2 - XfdesktopIconView::selected-shadow-y-offset = 2 - XfdesktopIconView::selected-shadow-color = "#00ff00" - XfdesktopIconView::shadow-blur-radius = 2 - - XfdesktopIconView::cell-spacing = 2 - XfdesktopIconView::cell-padding = 6 - XfdesktopIconView::cell-text-width-proportion = 1.9 - - base[NORMAL] = "#00ff00" - base[SELECTED] = "#5050ff" - base[ACTIVE] = "#0000ff" - - fg[NORMAL] = "#ff0000" - fg[SELECTED] = "#ff0000" - fg[ACTIVE] = "#ff0000" -} -widget_class "*XfdesktopIconView*" style "xfdesktop-icon-view" - -The first four entries set the opacity of the rounded text background -(allowed values are from 0 (totally transparent) to 255 (totally opaque), -and whether or not unselected icons get their labels ellipsized -(truncated) to fit on one line. (The 'selected-' version controls the -opacity of icons that have been selected with the mouse.) The tooltip-size -determines how large the image preview will be when the mouse is hovered -over an icon (allowed values are from 0 (not shown) to 512, values larger -than 256 may cause poor image quality however.) - -The second seven entries can be used to enable a text shadow to be painted -with the icon labels. The offsets are in pixels. Setting them to 0 (the -defaults) will disable the shadows entirely. Again, the 'selected-' -versions apply to icons that have been selected with the mouse. The -shadow-blur-radius property optionally applies a blur to the shadows when -it is greater than 1 improving the style, but needs a little more CPU -processing, and therefore also is disabled by default. - -The third four entries set spacing and sizing for individual icons on -the grid. The 'cell-spacing' property specifies the spacing between each -'cell' in the grid of icons. The 'cell-padding' property sets extra -padding placed around each icon+text. The units for these two are in -pixels. The 'cell-text-width-proportion' property specifies the maximum -width of the text label underneat the icon, as a multiplier of the icon -width (so for 30px icons, '2.5' would leave a 75px wide area underneath -for the text). - -The fourth three entries set the color of the rounded text background. -* NORMAL sets the color for the regular, unselected state. -* SELECTED sets the color for when the icon is selected, and the desktop has - keyboard/mouse focus. -* ACTIVE sets the color for when the icon is selected, but the desktop does - not have keyboard/mouse focus. - -The final three entries set the color of the label text. See above for the -differences between NORMAL, SELECTED, and ACTIVE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..e6a75368 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +## What is it? + +xfdesktop is a desktop manager for the Xfce Desktop Environment. Desktop +in this respect means the root window (or, rather, a window that sits on top +of the root window). The manager handles the following tasks: +* background image / color +* root menu, window list +* minimized app icons +* file icons on the desktop (using Thunar libs) + + +## Minimum Requirements + +* intltool 0.31 +* GTK+ 3.22.0 +* libxfce4util 4.13 +* libxfce4ui 4.13 +* libwnck 3.14 +* libexo 0.11 +* xfconf 4.12.1 +* garcon 0.6.0 (optional; required for apps menu) +* thunar 1.7.0 (optional; required for file icons) +* tumbler 1.6 (optional; enables thumbnail previews for file icons) +* cairo 1.12 + + +## Installation + +The file [`INSTALL`](INSTALL) contains generic installation instructions. + + +## Debugging Support + +xfdesktop currently supports three different levels of debugging support, +which can be setup using the configure flag `--enable-debug` (check the output +of `configure --help`): + +| Argument | Description | +| ------- | ----------- | +| `yes` | This is the default for Git snapshot builds. It adds all kinds of checks to the code, and is therefore likely to run slower. Use this for development of xfdesktop and locating bugs in xfdesktop. | +| `minimum` | This is the default for release builds. **This is the recommended behaviour.** | +| `no` | Disables all sanity checks. Don't use this unless you know exactly what you do. | + + +## How to report bugs? + +Bugs should be reported to the [Xfce bug tracking system](https://bugzilla.xfce.org) +against the product xfdesktop. You will need to create an account for yourself. diff --git a/configure.ac.in b/configure.ac.in index 80155b4b..5e7347c0 100644 --- a/configure.ac.in +++ b/configure.ac.in @@ -39,7 +39,7 @@ AC_INIT([xfdesktop], [xfdesktop_version], [https://bugzilla.xfce.org/]) AC_PREREQ([2.60]) dnl init automake -AM_INIT_AUTOMAKE([1.8 dist-bzip2 tar-ustar no-dist-gzip]) +AM_INIT_AUTOMAKE([1.8 dist-bzip2 tar-ustar no-dist-gzip foreign]) AC_CONFIG_HEADERS([config.h]) AC_CONFIG_MACRO_DIRS([m4]) AM_MAINTAINER_MODE |