mirror of
https://git.sr.ht/~ryuslash/yoshi-theme
synced 2025-01-31 11:25:51 +01:00
Reformat README
This file should be viewed with ‘visual-line-mode’ and ‘org-indent-mode’ on. That will properly format the org-mode buffer.
This commit is contained in:
parent
54b86c09d9
commit
7a04227840
1 changed files with 66 additions and 83 deletions
33
README.org
33
README.org
|
@ -3,9 +3,7 @@
|
||||||
|
|
||||||
* Yoshi theme
|
* Yoshi theme
|
||||||
|
|
||||||
My cat is named Yoshi and I was just working on a random new 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.
|
||||||
which was =new-theme= for a while. I couldn't think of a name so I
|
|
||||||
named it after him.
|
|
||||||
|
|
||||||
** Screenshot
|
** Screenshot
|
||||||
|
|
||||||
|
@ -13,9 +11,7 @@
|
||||||
|
|
||||||
** Themed modes
|
** Themed modes
|
||||||
|
|
||||||
Here is a list of the themed major and minor modes. Certain modes
|
Here is a list of the themed major and minor modes. Certain modes may only have been themed partially and this list may not be complete.
|
||||||
may only have been themed partially and this list may not be
|
|
||||||
complete.
|
|
||||||
|
|
||||||
- Circe
|
- Circe
|
||||||
- Compilation mode
|
- Compilation mode
|
||||||
|
@ -51,9 +47,7 @@
|
||||||
|
|
||||||
** License
|
** License
|
||||||
|
|
||||||
This project is licensed under the GNU General Public 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]].
|
||||||
version 3 or (at your option) any later version. You can read the
|
|
||||||
terms of this license [[file:COPYING][here]].
|
|
||||||
|
|
||||||
** Installation
|
** Installation
|
||||||
|
|
||||||
|
@ -61,18 +55,11 @@
|
||||||
|
|
||||||
*** Installation with ELPA
|
*** Installation with ELPA
|
||||||
|
|
||||||
To install Yoshi theme using the built-in Emacs package
|
To install Yoshi theme using the built-in Emacs package manager you should have [[https://melpa.org/][MELPA]] or [[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.
|
||||||
manager you should have [[https://melpa.org/][MELPA]]
|
|
||||||
or [[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
|
*** Installation from git
|
||||||
|
|
||||||
To use a version from the latest git checkout you should clone the
|
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=.
|
||||||
repository and then add the directory to your
|
|
||||||
=custom-theme-load-path=.
|
|
||||||
|
|
||||||
In a shell execute:
|
In a shell execute:
|
||||||
|
|
||||||
|
@ -89,9 +76,7 @@
|
||||||
|
|
||||||
** Enabling Yoshi theme
|
** Enabling Yoshi theme
|
||||||
|
|
||||||
Once you've installed Yoshi theme you can either use =M-x
|
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=:
|
||||||
load-theme= to enable it interactively for the current session, or
|
|
||||||
put the following in your =~/.emacs.d/init.el=:
|
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(load-theme 'yoshi :no-confirm)
|
(load-theme 'yoshi :no-confirm)
|
||||||
|
@ -99,15 +84,13 @@
|
||||||
|
|
||||||
** Installation in Spacemacs
|
** Installation in Spacemacs
|
||||||
|
|
||||||
Edit your .spacemacs file ~(SPC f e d)~ and add the ~yoshi-theme~
|
Edit your .spacemacs file ~(SPC f e d)~ and add the ~yoshi-theme~ package:
|
||||||
package:
|
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
dotspacemacs-additional-packages '(yoshi-theme)
|
dotspacemacs-additional-packages '(yoshi-theme)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Add the theme to the top of the themes list to make it the default
|
Add the theme to the top of the themes list to make it the default theme, for example:
|
||||||
theme, for example:
|
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
dotspacemacs-themes '(yoshi
|
dotspacemacs-themes '(yoshi
|
||||||
|
|
Loading…
Reference in a new issue