mirror of
https://git.sr.ht/~ryuslash/yoshi-theme
synced 2025-01-31 03:15:52 +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
149
README.org
149
README.org
|
@ -3,119 +3,102 @@
|
||||||
|
|
||||||
* 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
|
||||||
|
|
||||||
[[file:screenshot.png]]
|
[[file:screenshot.png]]
|
||||||
|
|
||||||
** 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
|
||||||
- CSS mode
|
- CSS mode
|
||||||
- Diff
|
- Diff
|
||||||
- Dired
|
- Dired
|
||||||
- Ediff
|
- Ediff
|
||||||
- ERC
|
- ERC
|
||||||
- ERT Test results
|
- ERT Test results
|
||||||
- Eshell
|
- Eshell
|
||||||
- Flycheck
|
- Flycheck
|
||||||
- Gnus
|
- Gnus
|
||||||
- Helm
|
- Helm
|
||||||
- Highlight indent
|
- Highlight indent
|
||||||
- Hydra
|
- Hydra
|
||||||
- Identica
|
- Identica
|
||||||
- Ido
|
- Ido
|
||||||
- Jabber
|
- Jabber
|
||||||
- JS2 Mode
|
- JS2 Mode
|
||||||
- Magit
|
- Magit
|
||||||
- Markdown
|
- Markdown
|
||||||
- Message mode
|
- Message mode
|
||||||
- Org mode
|
- Org mode
|
||||||
- Outline mode
|
- Outline mode
|
||||||
- Rainbow delimiters
|
- Rainbow delimiters
|
||||||
- ReStructured Text mode
|
- ReStructured Text mode
|
||||||
- Sh mode
|
- Sh mode
|
||||||
- Slime repl
|
- Slime repl
|
||||||
- Smerge
|
- Smerge
|
||||||
- Term mode
|
- Term mode
|
||||||
- Texinfo mode
|
- Texinfo mode
|
||||||
- Whitespace mode
|
- Whitespace mode
|
||||||
|
|
||||||
** 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
|
||||||
|
|
||||||
Installation comes in two flavors.
|
Installation comes in two flavors.
|
||||||
|
|
||||||
*** 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:
|
||||||
|
|
||||||
#+BEGIN_EXAMPLE
|
#+BEGIN_EXAMPLE
|
||||||
cd ~/
|
cd ~/
|
||||||
git clone git://github.com/ryuslash/yoshi-theme.git
|
git clone git://github.com/ryuslash/yoshi-theme.git
|
||||||
#+END_EXAMPLE
|
#+END_EXAMPLE
|
||||||
|
|
||||||
Then add to your =~/.emacs.d/init.el=:
|
Then add to your =~/.emacs.d/init.el=:
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(add-to-list 'custom-theme-load-path (expand-file-name "~/yoshi-theme"))
|
(add-to-list 'custom-theme-load-path (expand-file-name "~/yoshi-theme"))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
** 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)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
** 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
|
||||||
monokai
|
monokai
|
||||||
spacemacs-dark
|
spacemacs-dark
|
||||||
spacemacs-light
|
spacemacs-light
|
||||||
solarized-light
|
solarized-light
|
||||||
solarized-dark
|
solarized-dark
|
||||||
leuven
|
leuven
|
||||||
zenburn)
|
zenburn)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
Loading…
Reference in a new issue