From c9c4d4fbb5e4cfbf3affb83603df9629c344c227 Mon Sep 17 00:00:00 2001 From: Devine Lu Linvega Date: Fri, 14 Sep 2018 10:08:37 +1200 Subject: Updated README.md --- COLLECTION.md | 104 ++++++++++++++++++++++++++++++++++ README.md | 152 ++++++++++++++++---------------------------------- assets/2b.svg | 2 +- assets/cpc.svg | 2 +- assets/frameio.svg | 2 +- assets/lotus.svg | 8 +-- assets/merveilles.svg | 2 +- assets/pico8.svg | 2 +- assets/ramma.svg | 2 +- assets/snow.svg | 6 +- assets/soft.svg | 2 +- assets/tape.svg | 6 +- assets/tape_se.svg | 6 +- assets/toxik.svg | 2 +- index.js | 4 +- themes/2b.thm | 2 +- themes/cpc.thm | 2 +- themes/frameio.thm | 2 +- themes/lotus.thm | 8 +-- themes/merveilles.thm | 2 +- themes/pico8.thm | 2 +- themes/ramma.thm | 2 +- themes/snow.thm | 2 +- themes/soft.thm | 2 +- themes/tape.thm | 2 +- themes/tape_se.thm | 2 +- themes/toxik.thm | 2 +- 27 files changed, 190 insertions(+), 142 deletions(-) create mode 100644 COLLECTION.md diff --git a/COLLECTION.md b/COLLECTION.md new file mode 100644 index 0000000..43cdcb6 --- /dev/null +++ b/COLLECTION.md @@ -0,0 +1,104 @@ +# Collection + +## [2b](themes/2b.thm) +![2b](assets/2b.svg) + +## [apollo](themes/apollo.thm) +![apollo](assets/apollo.svg) + +## [ash](themes/ash.thm) +![ash](assets/ash.svg) + +## [apollo11](themes/apollo11.thm) +![apollo11](assets/apollo11.svg) + +## [battlestation](themes/battlestation.thm) +![battlestation](assets/battlestation.svg) + +## [berry](themes/berry.thm) +![berry](assets/berry.svg) + +## [blanc](themes/blanc.thm) +![blanc](assets/blanc.svg) + +## [cina](themes/cina.thm) +![cina](assets/cina.svg) + +## [coal](themes/coal.thm) +![coal](assets/coal.svg) + +## [commodore](themes/commodore.thm) +![commodore](assets/commodore.svg) + +## [cpc](themes/cpc.thm) +![cpc](assets/cpc.svg) + +## [deuveir](themes/deuveir.thm) +![deuveir](assets/deuveir.svg) + +## [donsol](themes/donsol.thm) +![donsol](assets/donsol.svg) + +## [frameio](themes/frameio.thm) +![frameio](assets/frameio.svg) + +## [gameboy](themes/gameboy.thm) +![gameboy](assets/gameboy.svg) + +## [lotus](themes/lotus.thm) +![lotus](assets/lotus.svg) + +## [mahou](themes/mahou.thm) +![mahou](assets/mahou.svg) + +## [marble](themes/marble.thm) +![marble](assets/marble.svg) + +## [merveilles](themes/merveilles.thm) +![merveilles](assets/merveilles.svg) + +## [noir](themes/noir.thm) +![noir](assets/noir.svg) + +## [pale](themes/pale.thm) +![pale](assets/pale.svg) + +## [pico8](themes/pico8.thm) +![pico8](assets/pico8.svg) + +## [ramma](themes/ramma.thm) +![ramma](assets/ramma.svg) + +## [raspberry](themes/raspberry.thm) +![raspberry](assets/raspberry.svg) + +## [robo](themes/robo.thm) +![robo](assets/robo.svg) + +## [seaweed](themes/seaweed.thm) +![seaweed](assets/seaweed.svg) + +## [snow](themes/snow.thm) +![snow](assets/snow.svg) + +## [soft](themes/soft.thm) +![soft](assets/soft.svg) + +## [solitaire](themes/solitaire.thm) +![solitaire](assets/solitaire.svg) + +## [soyuz](themes/soyuz.thm) +![soyuz](assets/soyuz.svg) + +## [swiss](themes/swiss.thm) +![swiss](assets/swiss.svg) + +## [tape](themes/tape.thm) +![tape](assets/tape.svg) + +## [tape_se](themes/tape_se.thm) +![tape_se](assets/tape_se.svg) + +## [toxik](themes/toxik.thm) +![toxik](assets/toxik.svg) + diff --git a/README.md b/README.md index 5497d90..257f9e7 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,57 @@ # Themes -This collection of themes are meant to be used with [Marabu](https://github.com/hundredrabbits/Marabu), [Ronin](https://github.com/hundredrabbits/Ronin), [Left](https://github.com/hundredrabbits/Left), [Donsol](https://github.com/hundredrabbits/Donsol) and [Dotgrid](https://github.com/hundredrabbits/Dotgrid). -This collection may also be used with -[Tape](https://aeriform.itch.io/tape) by Aeriform. +This repo documents the specs of the theme format used across the Hundred Rabbits' [ecosystem](https://github.com/hundredrabbits). You can also implement the theme support into your own apps. See the [Collection](COLLECTION.md) for all available themes. -## Install -To install a theme, simply drag the `thm` file onto the application window. -You are welcome to submit your own themes to this collection! - -## [2b](themes/2b.thm) -![2b](assets/2b.svg) - -## [apollo](themes/apollo.thm) -![apollo](assets/apollo.svg) - -## [apollo11](themes/apollo11.thm) -![apollo11](assets/apollo11.svg) - -## [ash](themes/ash.thm) -![ash](assets/ash.svg) - -## [battlestation](themes/battlestation.thm) -![battlestation](assets/battlestation.svg) - -## [berry](themes/berry.thm) -![berry](assets/berry.svg) - -## [blanc](themes/blanc.thm) -![blanc](assets/blanc.svg) - -## [cina](themes/cina.thm) -![cina](assets/cina.svg) - -## [coal](themes/coal.thm) -![coal](assets/coal.svg) - -## [commodore](themes/commodore.thm) -![commodore](assets/commodore.svg) - -## [cpc](themes/cpc.thm) -![cpc](assets/cpc.svg) - -## [deuveir](themes/deuveir.thm) -![deuveir](assets/deuveir.svg) - -## [donsol](themes/donsol.thm) -![donsol](assets/donsol.svg) - -## [frameio](themes/frameio.thm) -![frameio](assets/frameio.svg) - -## [gameboy](themes/gameboy.thm) -![gameboy](assets/gameboy.svg) +## Specs + +``` +{ + "meta": { + "author": "aeriform", + "version": 2, + "revision": 1 + }, + "data": { + "background": "#d4d3c0", + "b_high": "#ede6d4", + "b_med": "#534e41", + "b_low": "#dfddca", + "b_inv": "#cc295c" + "f_high": "#534e41", + "f_med": "#534e41", + "f_low": "#ede6d4", + "f_inv": "#cc295c", + } +} +``` + +### Usage + +To implement support, you need to add the [theme.js](https://github.com/hundredrabbits/Dotgrid/blob/master/desktop/sources/scripts/lib/theme.js), and the [theme.css](https://github.com/hundredrabbits/Dotgrid/blob/master/desktop/sources/links/theme.css). The CSS is where the style is applies onto the html elements. + +- `background`, Background, general. +- `f_high`, Foreground, high-contrast. +- `f_med`, Foreground, medium-contrast. +- `f_low`, Foreground, low-contrast. +- `f_inv`, Foreground, inverted. +- `f_high`, Background, high-contrast. +- `f_med`, Background, medium-contrast. +- `f_low`, Background, low-contrast. +- `f_inv`, Background, inverted. + +## Supported Applications + +- [Marabu](https://github.com/hundredrabbits/Marabu), music tool. +- [Left](https://github.com/hundredrabbits/Left), writing tool. +- [Dotgrid](https://github.com/hundredrabbits/Dotgrid), vector tool. +- [Donsol](https://github.com/hundredrabbits/Donsol), card game. -## [lotus](themes/lotus.thm) -![lotus](assets/lotus.svg) - -## [mahou](themes/mahou.thm) -![mahou](assets/mahou.svg) - -## [marble](themes/marble.thm) -![marble](assets/marble.svg) - -## [merveilles](themes/merveilles.thm) -![merveilles](assets/merveilles.svg) - -## [noir](themes/noir.thm) -![noir](assets/noir.svg) - -## [pale](themes/pale.thm) -![pale](assets/pale.svg) - -## [pico8](themes/pico8.thm) -![pico8](assets/pico8.svg) - -## [ramma](themes/ramma.thm) -![ramma](assets/ramma.svg) - -## [raspberry](themes/raspberry.thm) -![raspberry](assets/raspberry.svg) - -## [robo](themes/robo.thm) -![robo](assets/robo.svg) - -## [solitaire](themes/solitaire.thm) -![solitaire](assets/solitaire.svg) - -## [seaweed](themes/seaweed.thm) -![seaweed](assets/seaweed.svg) - -## [snow](themes/snow.thm) -![snow](assets/snow.svg) - -## [soft](themes/soft.thm) -![soft](assets/soft.svg) - -## [soyuz](themes/soyuz.thm) -![soyuz](assets/soyuz.svg) - -## [swiss](themes/swiss.thm) -![swiss](assets/swiss.svg) +This collection may also be used with +[Tape](https://aeriform.itch.io/tape) by Aeriform. -## [tape](themes/tape.thm) -![tape](assets/tape.svg) +## Extras -## [tape_se](themes/tape_se.thm) -![tape_se](assets/tape_se.svg) +You are welcome to submit your own themes to this collection! -## [toxik](themes/toxik.thm) -![toxik](assets/toxik.svg) diff --git a/assets/2b.svg b/assets/2b.svg index c7bd447..6786cee 100644 --- a/assets/2b.svg +++ b/assets/2b.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/assets/cpc.svg b/assets/cpc.svg index a367b07..c11787c 100644 --- a/assets/cpc.svg +++ b/assets/cpc.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/assets/frameio.svg b/assets/frameio.svg index 83d6b8f..415e156 100644 --- a/assets/frameio.svg +++ b/assets/frameio.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/assets/lotus.svg b/assets/lotus.svg index 9f2b609..000615b 100644 --- a/assets/lotus.svg +++ b/assets/lotus.svg @@ -2,11 +2,11 @@ - - + + - - + + \ No newline at end of file diff --git a/assets/merveilles.svg b/assets/merveilles.svg index 5eef4b8..9925c43 100644 --- a/assets/merveilles.svg +++ b/assets/merveilles.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/assets/pico8.svg b/assets/pico8.svg index bfad90e..4abe3ad 100644 --- a/assets/pico8.svg +++ b/assets/pico8.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/assets/ramma.svg b/assets/ramma.svg index c4cc893..f329224 100644 --- a/assets/ramma.svg +++ b/assets/ramma.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/assets/snow.svg b/assets/snow.svg index 58b6285..4114b18 100644 --- a/assets/snow.svg +++ b/assets/snow.svg @@ -6,7 +6,7 @@ - + - - + + \ No newline at end of file diff --git a/assets/soft.svg b/assets/soft.svg index b43b70a..e735a13 100644 --- a/assets/soft.svg +++ b/assets/soft.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/assets/tape.svg b/assets/tape.svg index 04a8840..1f280c0 100644 --- a/assets/tape.svg +++ b/assets/tape.svg @@ -6,7 +6,7 @@ - + - - + + \ No newline at end of file diff --git a/assets/tape_se.svg b/assets/tape_se.svg index c2439b1..1856dd5 100644 --- a/assets/tape_se.svg +++ b/assets/tape_se.svg @@ -6,7 +6,7 @@ - + - - + + \ No newline at end of file diff --git a/assets/toxik.svg b/assets/toxik.svg index fd00a3e..15e533b 100644 --- a/assets/toxik.svg +++ b/assets/toxik.svg @@ -9,4 +9,4 @@ - + \ No newline at end of file diff --git a/index.js b/index.js index 7dca234..21ef5a8 100644 --- a/index.js +++ b/index.js @@ -2,7 +2,7 @@ fs = require('fs'); path = require('path'); var normalizedPath = require("path").join(__dirname, "themes"); -var html = "# Themes\nThis collection of themes are meant to be used with [Marabu](https://github.com/hundredrabbits/Marabu), [Ronin](https://github.com/hundredrabbits/Ronin), [Left](https://github.com/hundredrabbits/Left), [Donsol](https://github.com/hundredrabbits/Donsol) and [Dotgrid](https://github.com/hundredrabbits/Dotgrid).\n\n\n\n## Install\nTo install a theme, simply drag the `thm` file onto the application window.\nYou are welcome to submit your own themes to this collection!\n\n" +var html = "# Collection\n\n" // opt in to upgrade the schema change // would require to do 'theme = theme.data' in client apps @@ -52,7 +52,7 @@ function safe_parse_json(text) function generate(html) { - fs.writeFile("README.md", html, function(err) { + fs.writeFile("COLLECTION.md", html, function(err) { if(err) {return console.log(err);} console.log("Done.") }); diff --git a/themes/2b.thm b/themes/2b.thm index 532ddf2..4dfcd95 100755 --- a/themes/2b.thm +++ b/themes/2b.thm @@ -15,4 +15,4 @@ "b_low": "#dfddca", "b_inv": "#cc295c" } -} +} \ No newline at end of file diff --git a/themes/cpc.thm b/themes/cpc.thm index 1d48381..fb6f43f 100644 --- a/themes/cpc.thm +++ b/themes/cpc.thm @@ -15,4 +15,4 @@ "b_low": "#000062", "b_inv": "#ff0000" } -} +} \ No newline at end of file diff --git a/themes/frameio.thm b/themes/frameio.thm index b604c8a..21f8748 100755 --- a/themes/frameio.thm +++ b/themes/frameio.thm @@ -15,4 +15,4 @@ "b_low": "#394153", "b_inv": "#5b52fe" } -} +} \ No newline at end of file diff --git a/themes/lotus.thm b/themes/lotus.thm index 421d854..eca2728 100644 --- a/themes/lotus.thm +++ b/themes/lotus.thm @@ -7,12 +7,12 @@ "data": { "background": "#161616", "f_high": "#f0c098", - "f_med": "#999999", - "f_low": "#cccccc", + "f_med": "#333333", + "f_low": "#555555", "f_inv": "#222222", "b_high": "#ffffff", - "b_med": "#333333", - "b_low": "#444444", + "b_med": "#222222", + "b_low": "#333333", "b_inv": "#f0c098" } } \ No newline at end of file diff --git a/themes/merveilles.thm b/themes/merveilles.thm index ac0cbfb..4a023b8 100755 --- a/themes/merveilles.thm +++ b/themes/merveilles.thm @@ -15,4 +15,4 @@ "b_low": "#111110", "b_inv": "#3bffbe" } -} +} \ No newline at end of file diff --git a/themes/pico8.thm b/themes/pico8.thm index 26a45c5..82184ef 100755 --- a/themes/pico8.thm +++ b/themes/pico8.thm @@ -15,4 +15,4 @@ "b_low": "#695f56", "b_inv": "#ff78a9" } -} +} \ No newline at end of file diff --git a/themes/ramma.thm b/themes/ramma.thm index 8a354ff..e52facb 100755 --- a/themes/ramma.thm +++ b/themes/ramma.thm @@ -15,4 +15,4 @@ "b_low": "#2d2d30", "b_inv": "#ededed" } -} +} \ No newline at end of file diff --git a/themes/snow.thm b/themes/snow.thm index a454fe5..caaea22 100644 --- a/themes/snow.thm +++ b/themes/snow.thm @@ -15,4 +15,4 @@ "b_low": "#f5f5f5", "b_inv": "#ed2c3e" } -} +} \ No newline at end of file diff --git a/themes/soft.thm b/themes/soft.thm index 7ba0c79..b6ee97e 100755 --- a/themes/soft.thm +++ b/themes/soft.thm @@ -15,4 +15,4 @@ "b_low": "#ffffff", "b_inv": "#e1698d" } -} +} \ No newline at end of file diff --git a/themes/tape.thm b/themes/tape.thm index 80527df..f81eaec 100644 --- a/themes/tape.thm +++ b/themes/tape.thm @@ -15,4 +15,4 @@ "b_low": "#e5e3dc", "b_inv": "#eb3f48" } -} +} \ No newline at end of file diff --git a/themes/tape_se.thm b/themes/tape_se.thm index 9c583f8..436c5da 100755 --- a/themes/tape_se.thm +++ b/themes/tape_se.thm @@ -15,4 +15,4 @@ "b_low": "#2f2d2b", "b_inv": "#eb3f48" } -} +} \ No newline at end of file diff --git a/themes/toxik.thm b/themes/toxik.thm index 2d3576c..23365de 100755 --- a/themes/toxik.thm +++ b/themes/toxik.thm @@ -15,4 +15,4 @@ "b_low": "#464646", "b_inv": "#ff681d" } -} +} \ No newline at end of file -- cgit v1.2.3