Skip to content

Commit

Permalink
Update the geany-themes README.md file
Browse files Browse the repository at this point in the history
Remove old/obsolete information, add additional information and
generally reorganize it a bit.
  • Loading branch information
codebrainz committed Jul 17, 2018
1 parent 2379c69 commit 4598c9f
Showing 1 changed file with 55 additions and 59 deletions.
114 changes: 55 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,79 +10,75 @@ or ported from color schemes for other editors. These schemes are compatible
with Geany 1.22 and greater. Check out the [screenshots][scrn] to get an
idea for what each color scheme looks like.

If you're using an older version of Geany, see these links:

* 0.19 or earlier is not supported
* 0.20 [geany-themes-0.20.zip][020zip] or [geany-themes-0.20.tar.bz2][020tar]
* 0.21 [geany-themes-0.21.1.zip][021zip] or [geany-themes-0.21.1.tar.bz2][021tar]

**Note:** There are no plans to further update Geany Themes releases before
the one for Geany 1.22. If you send me an udpated and tested
`geany-themes-0.2x.x.zip` or `geany-themes-0.2x.x.tar.bz2` file (or both),
I will check them out and add them as updated download links here in the
[README.md][readme] and in the [Github downloads][ghdl].
Installation
------------

Unix-like Installation
----------------------
**Note:** the following instructions will overwrite any themes with
the same filename you have already installed, so if you have customized
any of them, you will lose your customizations if you don't back them
up first.

Extract the tarball and copy all of the files in the `colorschemes` directory
to your `~/.config/geany/colorschemes/` directory. Create that directory if it
doesn't already exist.
### Unix-like Systems

Windows Installation
--------------------
Extract the zip file, tarball or checkout with Git to a local
directory. In this directory you will find a sub-directory named
`colorschemes` which contains all of the color scheme files. Copy all of
these `*.conf` files into the directory named
`~/.config/geany/colorschemes/`, where `~` means your personal home
directory. Create the `~/.config/geany/colorschemes/` directory if it
does not already exist.

Extract the tarball and copy all of the files in the `colorschemes` directory
to your `C:\Users\YourUserName\AppData\Roaming\geany\colorschemes` directory.
Create this directory if it doesn't already exist.
After copying the files you can choose a new theme by selecting
`Change Color Scheme...` from Geany's `View` menu.

**Note:** The Windows directory paths above are for Windows 7, they might be
different for other Windows versions (see the Geany manual).
### Windows

**Note:** Both of the above instructions will want to over-write your existing
colorschemes which you might have customized. Be sure to backup any files in
those directories that you do not want over-written.
Installing the themes on Windows is the same as with Unix-like systems
with the exception that the target directory will be different. With
Windows 7, the directory should be named
`C:\Users\YourUserName\AppData\Roaming\geany\colorschemes`, but the
exact path may vary depending on your Windows configuration and/or
version. Refer to [the Geany Manual][man-paths] for more information on
configuration file paths.

Docs
----
Documentation
-------------

If you want to add a theme, read the [ADDING-A-THEME.md][add-theme] file. If you
are a package maintainer, consult the [MAKING-A-RELEASE.md][make-release] file. For
all other cases, consult the official Geany documentation.

Known Bugs
----------

## Backwards-compatiblity

These color schemes are not compatible with older version of Geany, including
its old filetypes files, which you may have customized and are found in
your per-user configuration folder. All bets are off if you mix and match
old filetypes/color schemes and the color schemes here. The best way to
handle it is to simple move your old filetypes out of the way, copy the ones
you want to customize from Geany's system data folder and hand-copy over the
non-`[styling]` groups from the old filetypes file into the new one.

## Ubuntu Unity

There is a conflict in Geany's code when you are using Unity's DBUS menu (that
global menu at the top of the screen). The fix for this is available in the
1.22 release of Geany. To work around the problem in older versions, you can
ensure that the environment variable `UBUNTU_MENUPROXY` is set to `0` before
running Geany. This will disable Unity from stealing Geany's main menu and
will leave it within Geany's main window. You should be able to edit your
launchers for Geany to run like this `UBUNTU_MENUPROXY=0 geany`. You can even
make a Bash alias if you wish.
Other Themes
------------

Geany Themes was created and is maintained by Matthew Brush <matt@geany.org>.
You can also also sometimes find bleeding edge themes which have yet to
be fully integrated into the repository by looking at the
[Issues on Github][issues] labelled with the [`new-theme`][new-themes] label.
There may also be some unofficial themes on [the wiki][wiki-themes].

Be wary of old-style themes you may find in random places on the
Internet as they may only be compatible with old Geany versions before
1.22 and will likely result in grief. If the file doesn't contain a
section called `[theme_info]` it almost sure to be an incompatible
older theme. See below for more details.

Compatibility
-------------

These color schemes are not compatible with older version of Geany
prior to 1.22, including its old filetypes files, which you may have
customized and are found in your per-user configuration folder. All
bets are off if you mix and match old filetypes/color schemes and the
color schemes here. The best way to handle it is to simple move your
old filetypes out of the way, copy the ones you want to customize from
Geany's system data folder and hand-copy over the non-`[styling]`
groups from the old filetypes file into the new one.

[geany]: http://www.geany.org
[readme]: https://github.com/codebrainz/geany-themes/blob/master/README.md
[ghdl]: https://github.com/codebrainz/geany-themes/downloads
[scrn]: https://github.com/codebrainz/geany-themes/tree/master/screenshots
[020zip]: https://github.com/downloads/codebrainz/geany-themes/geany-themes-0.20.zip
[020tar]: https://github.com/downloads/codebrainz/geany-themes/geany-themes-0.20.tar.bz2
[021zip]: https://github.com/downloads/codebrainz/geany-themes/geany-themes-0.21.1.zip
[021tar]: https://github.com/downloads/codebrainz/geany-themes/geany-themes-0.21.1.tar.bz2
[scrn]: https://github.com/geany/geany-themes/tree/master/screenshots
[issues]: https://github.com/geany/geany-themes/issues?q=is%3Aopen
[new-themes]: https://github.com/geany/geany-themes/labels/new-theme
[wiki-themes]: https://wiki.geany.org/themes/start
[man-paths]: https://www.geany.org/manual/current/index.html#configuration-file-paths
[add-theme]: https://github.com/geany/geany-themes/blob/master/ADDING-A-THEME.md
[make-release]: https://github.com/geany/geany-themes/blob/master/MAKING-A-RELEASE.md

0 comments on commit 4598c9f

Please sign in to comment.