aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
blob: 23ebac6223119086c5e4d7c7ccc96527b771e5ab (plain)
1
2
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
* Yoshi theme

  My cat is named Yoshi and I was just working on a random new theme,
  which was =new-theme= for a while.  I couldn't think of a name so I
  named it after him.

** Screenshot

   [[file:screenshot.png]]

** License

   This project is licensed under the GNU General Public License
   version 3 or (at your option) any later version. You can read the
   terms of this license [[file:COPYING][here]].

** Installation

   Installation comes in two flavors.

*** Installation with ELPA

    To install Yoshi theme using the built-in Emacs package manager
    you should have [[https://marmalade-repo.org/][Marmalade]] in your =package-archives= list. When
    that's ready you can =M-x list-packages=, find =yoshi-theme=, press =i=
    and =x= and you're done.

*** Installation from git

    To use a version from the latest git checkout you should clone the
    repository and then add the directory to your
    =custom-theme-load-path=.

    In a shell execute:

    #+BEGIN_EXAMPLE
    cd ~/
    git clone git://github.com/ryuslash/yoshi-theme.git
    #+END_EXAMPLE

    Then add to your =~/.emacs.d/init.el=:

    #+BEGIN_SRC emacs-lisp
      (add-to-list 'custom-theme-load-path (expand-file-name "~/yoshi-theme"))
    #+END_SRC

** Enabling Yoshi theme

   Once you've installed Yoshi theme you can either use =M-x
   load-theme= to enable it interactively for the current session, or
   put the following in your =~/.emacs.d/init.el=:

   #+BEGIN_SRC emacs-lisp
     (load-theme 'yoshi :no-confirm)
   #+END_SRC