Permalink
Browse files

Update README pointing to deprecated branch.

  • Loading branch information...
1 parent 53c69ff commit 6299409d2132cf9e0bb636339a2755b4453a5a87 Matthew Brush committed Apr 5, 2011
Showing with 22 additions and 16 deletions.
  1. +22 −16 README.markdown
View
38 README.markdown
@@ -1,19 +1,24 @@
# Geany Color Themes #
+_UPDATE: if you aren't using the development version of Geany from Git
+or Subversion, you need to use the [deprecated branch][depr_branch]
+instead. The current master branch is using a new feature since the
+last Geany release and so is not compatible._
+
geany-themes is a set of filedefs and colorschemes containing some really nice
themes. I have ported almost all of the existing Geany themes I could find to
use the new filedefs so that you can still use those if you like them. Also
included is an `alt.conf` theme, ported from Geany to make sure you can still
use that as well, if you like it.
Some of the new themes were ported from the [gedit-themes][gedit_themes] and I
-plan to port the rest of them. There is also a bunch of available themes for
-[vim][vim_themes] and [TextMate][textmate_themes] that would also be nice to
+plan to port the rest of them. There is also a bunch of available themes for
+[vim][vim_themes] and [TextMate][textmate_themes] that would also be nice to
port.
Your help creating new themes and checking the `filedefs/filetype.*` files would
be greatly appreciated. You can use one of the existing themes as a starting
-point and there is more information in the [Geany Manual][geany_manual]. No
+point and there is more information in the [Geany Manual][geany_manual]. No
programming skills are required at all to help out.
_UPDATE: Since Geany r5596, the substitution and mappings hackery is no longer
@@ -24,18 +29,18 @@ I've removed those parts from geany-themes, simplifying the entire project._
## Installation: ##
-_NOTE: this will overwrite any of your customized filedefs/colorschemes in
+_NOTE: this will overwrite any of your customized filedefs/colorschemes in
your home directory, you may want to back them up first, for example:_
$ cd ~/.config/geany
$ tar cjf themes-orig.tar.bz2 colorschemes/ filedefs/
-Copy all the `filetypes.*` files from the `filedefs` dir into your Geany
+Copy all the `filetypes.*` files from the `filedefs` dir into your Geany
filedefs dir, for example `~/.config/geany/filedefs`.
$ cp -v filedefs/filetypes.* ~/.config/geany/filedefs
-Copy all the `*.conf` files from the colorschemes dir into your Geany
+Copy all the `*.conf` files from the colorschemes dir into your Geany
colorschemes dir, for example `~/.config/geany/colorschemes`.
$ cp -v colorschemes/*.conf ~/.config/geany/colorschemes
@@ -62,7 +67,7 @@ to hack/contribute.
### Installing: ###
-_NOTE: replace `~/src` with wherever you would like to keep the files. These
+_NOTE: replace `~/src` with wherever you would like to keep the files. These
are example commands only, don't just copy and paste them into a terminal._
$ killall geany
@@ -87,11 +92,11 @@ _NOTE: You'll need to fix any conflicts if you've made local changes._
### Making Changes: ###
-Edit any of the `colorschemes/*.conf` files or `filedefs/filetypes.*` files or
+Edit any of the `colorschemes/*.conf` files or `filedefs/filetypes.*` files or
create a new colorscheme `.conf` file in the `colorschemes` directory. Using an
existing theme (ex. `gedit.conf`) and modifying will be easier than from
scratch. When I get a chance I'll add a `README` in the `colorschemes`
-directory explaining in detail what all the named styles should be used for,
+directory explaining in detail what all the named styles should be used for,
but for the most part, the name says it all.
_NOTE: Geany doesn't update all of the styles when you select them through the
@@ -102,11 +107,11 @@ others yet._
Once you've made your changes, you can update your Geany by using the simple
Python scripts included with geany-themes. The installation script just copies
-all of the required files (ie. contents of `filedefs` and `colorschemes`
-directories) to your personal Geany config directory, assuming as a default
+all of the required files (ie. contents of `filedefs` and `colorschemes`
+directories) to your personal Geany config directory, assuming as a default
that `~/.config/geany` is where your Geany configuration files are. The
-installation utility has a `--help` option that shows usage. See the note
-above about restarting Geany.
+installation utility has a `--help` option that shows usage. See the note
+above about restarting Geany.
When creating a new theme, a command line session might look like this:
@@ -119,7 +124,7 @@ When creating a new theme, a command line session might look like this:
$ geany -v
... debug output, possibly containing any problems with the theme ...
-When editing a filetypes.* file, for example the Haskell lexer mappings, a
+When editing a filetypes.* file, for example the Haskell lexer mappings, a
command line session might look like this:
$ cd ~/src/geany-themes
@@ -132,7 +137,7 @@ command line session might look like this:
... debug output, possibly containing any problems with the mappings ...
When you are done making changes, follow the 'Submitting your changes' section.
-Don't forget to delete the `*.backup` file if you made one, before making a
+Don't forget to delete the `*.backup` file if you made one, before making a
patch.
@@ -141,7 +146,7 @@ patch.
$ cd ~/src/geany-themes
$ git diff > ../the_patch_name.patch
-Send me your patch and I'll apply it after a quick review or send a
+Send me your patch and I'll apply it after a quick review or send a
[pull request][pull_requests] on [GitHub][github] if you've forked the
repository.
@@ -151,3 +156,4 @@ repository.
[geany_manual]: http://www.geany.org/manual/current/index.html#filetype-definition-files
[pull_requests]: http://help.github.com/pull-requests
[github]: https://github.com
+[depr_branch]: https://github.com/codebrainz/geany-themes/tree/deprecated

0 comments on commit 6299409

Please sign in to comment.