Initial commit

1 files changed, 34 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..1d8eb9d
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+rockbox-theme-ipawbmini
+=======================
+
+This is a theme for iPod minis running Rockbox that makes it almost look like
+it's running the stock Apple software.  Yes, with the fonts and all;  though it
+also displays album artwork in the while playing screen.
+
+
+Building from source
+--------------------
+
+As all views share a common look (with the status bar and such) I decided to use
+a templating engine to keep the common parts in one place.  As usual, I chose
+Ruby for the task :)
+
+First, install Ruby using your favourite package manager, any version newer than
+2.6 should do fine.  Then install the dependencies using Bundler by running:
+
+    % bundle install
+
+Then run the theme generator.  This will create a new `dist` directory where the
+theme is being built to and all required files are copied into.
+
+    % ./gen_theme.rb
+
+The contents of the `dist/iPawbMini` directory can be then copied into the
+`.rockbox` directory of your iPod mini running Rockbox.
+
+
+License
+-------
+
+This work is licensed under a Creative Commons
+Attribution-NonCommercial-ShareAlike 4.0 International License.