aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.org (renamed from README.md)33
1 files changed, 16 insertions, 17 deletions
diff --git a/README.md b/README.org
index f182459..23e3461 100644
--- a/README.md
+++ b/README.org
@@ -1,37 +1,34 @@
-## Soria
+* Soria
Soria is a color theme which mixes:
-- xoria256: a color theme by Dmitry Zotikov, originally for Vim (see
- [original](http://www.vim.org/scripts/script.php?script_id=2140)). I did not
- do the initial porting from Vim to Emacs, I took it from
- [suxue](https://github.com/suxue/xoria256-emacs).
-- openSUSE: I took some colors from [openSUSE's Brand Guidelines](http://opensuse.github.io/branding-guidelines/).
+- [[http://www.vim.org/scripts/script.php?script_id=2140][xoria256]]: a color theme by Dmitry Zotikov, originally for Vim. I did not do
+ the initial porting from Vim to Emacs, I took it from [[https://github.com/suxue/xoria256-emacs][suxue]].
+- openSUSE: I took some colors from [[http://opensuse.github.io/branding-guidelines/][openSUSE's Brand Guidelines]].
-In the `soria-theme.el` file I list further acknowledgements.
+In the =soria-theme.el= file I list further acknowledgements. To install it,
+just drop the =soria-theme.el= file into your =~/.emacs.d= and load it with
+=load-theme=.
-To install it, just drop the `soria-theme.el` file into your `~/.emacs.d` and
-load it with `load-theme`.
+** Screenshots
-## Screenshots
-
-I've saved some screenshots in the `screenshots` directory. They do not show a
+I've saved some screenshots in the =screenshots= directory. They do not show a
full sample of all the defined colors, but it will give you a good idea of the
look and feel of this theme.
-## Configuration
+** Configuration
-This color theme defines the `soria` group, which in turn has only one
+This color theme defines the =soria= group, which in turn has only one
configuration option:
-- `soria-hide-helm-header`: the Helm package in combination with Projectile
+- =soria-hide-helm-header=: the Helm package in combination with Projectile
shows a header that in my humble opinion is quite useless and it's
distracting. For this reason, this header is hidden by default. If you set
it to false, then you'll see the header with the same colors as the status
line.
Moreover, this theme also provides one function that can be used as a hook:
-`soria-purple-identifiers`. As a reminder, this color theme is a port from Vim,
+=soria-purple-identifiers=. As a reminder, this color theme is a port from Vim,
and Vim and Emacs have some different takes on function identifiers. As such,
the original Vim theme defines identifiers as purple, but only method
definitions in Ruby, Perl and PHP (languages that I've used with these theme,
@@ -41,8 +38,9 @@ this port I could notice this a lot. For this reason, by default this color
theme for Emacs defines function identifiers as white, but it provides this
function so in other languages can be drawn in purple.
-## License
+** License
+#+BEGIN_SRC text
Copyright (C) 2016-2017 Miquel Sabaté Solà <mikisabate@gmail.com>
This program is free software: you can redistribute it and/or modify
@@ -57,3 +55,4 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
+#+END_SRC