From 462d92bdce2cf19ef371723aeacbd3420f631b4d Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Fri, 11 Dec 2015 08:56:10 +0100 Subject: [PATCH] Documentation. --- CONTRIBUTE.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 3 +++ 2 files changed, 48 insertions(+) create mode 100644 CONTRIBUTE.md diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..f377d25 --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,45 @@ +# Creating a theme + +> This guide is written for rofi 0.15.12 or higher. + +The guide assume you want to turn your current rofi setup into a theme. + +## Fork the repository + +On [GitHub](https://github.com/DaveDavenport/rofi-themes/) click the fork button. + +Make a local checkout of this new repository. + +## Create a theme file + +Inside the new repository create a file containing the theme settings: + +```bash +rofi -dump-xresources-theme > {themename}.theme +``` + +This stores the colors and separator style configuration in `{themename}.theme`. + +Edit this file to add more information if needed, for example if the theme should use a specific font. + +## Create screenshot and stage files + +Run the included script: + +```bash +./update.sh +``` +Make sure the script finished successful. + +## Commit and push changes + +```bash +git commit -m "Adding theme {themename} by {yourname}" +git push +``` + +## Create pull request + +On github create a pull request. +By making a pull request you agree with releasing your theme under the MIT license. + diff --git a/LICENSE b/LICENSE index b2c24b5..b925d0c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,6 @@ +Both the scripts and themes in this repository are released under the MIT license. + + The MIT License (MIT) Copyright (c) 2015 Dave Davenport