Add doc/website: our website source code.
[emacs-color-theme.git] / doc / website / site / index.muse
blobc574f075057901670db7df4c9d7e63c1235e3b56
1 #title color-theme homepage
2 #author "Xavier Maillard <xma@gnu.org>"
3 #keywords color theme, GNU emacs, muse
4 #project color-theme
6 * Introduction
8 color-theme-el is a GNU Emacs and XEmacs mode that provides nice and custom color
9 themes. You can then easily change part or all of your faces in all the modes
10 (providing the theme you use does effectivily define colors for the mode you
11 are interested in).
13 Here is a picture of what your GNU Emacs can look like:
15 *NEED A PIC HERE*
17 Latest version is 6.6.0
19 * Download
20 ** Tarballs
21 You can download color-theme from:
23  - http://download.savannah.nongnu.org/releases/color-theme/
25 There are both tar and zip files.
27 Note these files are gpg-signed (mandatory) against my key.
29 To verify the integrity of the files, just do:
31 <src lang="shell-script">
32 gpg --verify <file.sig> <file>
33 </src>
35 Replace file with color-theme-6.6.0.tar.gz or color-theme-6.6.0.zip
37 ** Slackware package
39 A SlackBuild script is available at your convenience either here or
40 into the [[http://slackbuilds.org][slackbuilds.org]] project. I recommend any slackware
41 user to use the powerful sbopkg.
43 To use slackbuild script from slackbuilds.org website, it is as simple
44 as running:
46 <src lang="shell-script">
47 sbopkg -r # update your package
48 sbopkg -i color-theme-el
49 sbopkg -i color-theme-extras-el
50 </src>
53 ** Debian specific (DEPRECATED)
55 Color theme has now his own Debian package named color-theme-el.
56 This is not a Debian official package so do not report bugs against
57 Debian. Use color theme project page for that.
59 So to benefit from this package, add these lines into your /etc/apt/sources.list:
61 Add this to your sources.list:
63  deb http://zedek.nerim.net/var/spool/repo ./ 
64  deb-src http://zedek.nerim.net/var/spool/repo ./
66 Then, ensure my key is in your keyring.
68 In general, you should have to add it:
70 :1. gpg --recv-key 1E028EA5
71 :2. gpg -a --export 1E028EA5 | sudo apt-key add -
72 :3. Verify with: sudo apt-key list
73 :4. apt-get update
74 :5. apt-get install color-theme-el
76 That should be enough.
78 * Configuration
80 This section suppose you have already installed color-theme-el either
81 using the tarball or using a package manager.
83 All you need to do in order to configure your color-theme-el package
84 is to add this to your .emacs.el file:
86 <src lang="emacs-lisp">
87 (add-to-list 'load-path "/path/to/color-theme.el/file")
88 (require 'color-theme)
89 (eval-after-load "color-theme"
90   '(progn
91      (color-theme-initialize)
92      (color-theme-hober)))
93 </src>
95 Then you can choose your color-theme theme by issuing M-x
96 color-theme-<TAB> RET
99 * Notes
101 ** Grabbing CVS version (DEPRECATED)
103 If you want to grab developement version out of CVS, just use this command:
105   :cvs -d:pserver:anonymous@cvs.gna.org:/cvs/color-theme co color-theme
107 (For write access on the repository, ask it to me: zedek (at) gnu.org)
109 Note: CVS has been dropped in favor of a more decentralized and robust SCM called Mercurial. More informations to come about the way to get the source code to you.
111 ** BUGS/Wishlist
113 See the [[http://gna.org/bugs/?group=color-theme][bug-tracking]] interface for current bugs.
114 Wishlist items are those with a severity of 1.
116 Please use these tools to report problems and do not send mail personally to
117 me. These tools are there in order to be able to track them all. On
118 the contrary, my spam filter may catch your mail to me. So if you
119 really want something to be added/fixed, use the Right tool.
121 ** Help & mailing-list
123 You can find help on the [[http://www.emacswiki.org/cgi-bin/wiki/ColorTheme][EmacsWiki color-theme page]].
125 For your convenience, we have created two mailing-list:
127 1. One used to follow color-theme-el development
128 2. One dedicated to common user questions, helps, contributions
130 Please visit [[https://gna.org/mail/?group=color-theme][color-theme-el mailing-list page]] for instructions on subscribing to them.
132 * Tasks
133 ** DONE Add color-theme.el to the download section
134    CLOSED: [2006-05-22 lun 00:00]
135   
137 ** DONE Create a website for Color Theme
138    CLOSED: [2006-05-28 dim 23:00]
139 ** DONE Add a header to color-theme-library.el
140    CLOSED: [2006-05-22 lun 00:01]
141 ** TODO Add info file
142 ** DONE Add README file
143    CLOSED: [2006-05-28 dim 22:14]
144 ** DONE Add NEWS file
145    CLOSED: [2006-05-28 dim 22:14]
146 ** TODO Add LEGAL/COPYING file (GPL license)
147    CLOSED: [2006-05-22 lun 00:07]
148 ** DONE Prepare 6.6.0 release
149    CLOSED: [2006-05-28 dim 22:14]
150 ** TODO Add distro specific build files
151 ** TODO Add THANKS list
152    Name it CREDITS.themes
153 ** TODO Cleanup code
154 ** TODO Post on gnu.emacs.source
155 ** DONE Add makefile
156    CLOSED: [2006-05-28 dim 23:00]
157 ** DONE Add autoload cookies
158    CLOSED: [2006-05-22 lun 00:19]
160 ** TODO Make color-theme-submit more intelligent
161    QUOTE: ask for theme name
162           add bytecompile directives
163           offer to add the theme in list of color-themes
164 ** TODO Add Makefile to ease installation
165 ** TODO Add distro build scripts
166 ** TODO Separate themes: one theme == one file
168 ** DONE Add HACKING notice
169    CLOSED: [2006-05-28 dim 23:01]
170 ** DONE Tag cvs with RELEASE_$(VERSION)
171    CLOSED: [2006-05-28 dim 23:01]
172 ** TODO Add TODO file
173 ** DONE Add BUGS file
174    CLOSED: [2006-05-28 dim 22:13]
175 ** TODO Report bugs on debian against emacs-goodies-el
176    Ask for color-theme.el removal
177 ** TODO ITP on Debian for color-theme-el
178 ** DONE Put color-theme-library.el into themes
179    CLOSED: [2006-05-28 dim 22:13]
180 ** TODO Split color-theme-library.el
181    Split it into as many theme files as there are themes
182 ** TODO Rework all themes so that it uses define-color-theme
185 ** TODO Inform users/developpers of CVS to Mercurial migration
186 ** TODO Add a small tutorial to use color-theme-el mercurial repository
187 ** TODO Inform users of mailing-lists existence
188 ** TODO Add slackbuild
189 ** TODO Change debian repository from nerim to gna
190    QUOTE: follow [[https://gna.org/cookbook/?func=detailitem&item_id=118]["Creating an apt repo on Gna!"]]