diff --git a/;wq b/;wq deleted file mode 100644 index 2fc45e6..0000000 --- a/;wq +++ /dev/null @@ -1,11 +0,0 @@ - -$use-logo: true; - -$logo-image-width: 150px; - -$header-padding-vertical: 20px; - -$brand-primary: #444; - -$font-size-base: 20px; -$font-size-large-px: 24px; diff --git a/README.md b/README.md index 8333e94..8e00eaf 100755 --- a/README.md +++ b/README.md @@ -1,65 +1,22 @@ -# PurpleMine 2 +# Roblib Redmine +A free Redmine 3.0+ theme written in SCSS ([based on Purplemine2](https://github.com/mrliptontea/PurpleMine2)). +It uses [normalize.css] and benefits from some parts of [Bootstrap][bootstrap-sass] like mixins, structure, and stuff. -A free Redmine 3.0+ theme written in SCSS. - -![The MIT License](https://img.shields.io/badge/license-MIT-584492.svg) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) ![Run linters](https://github.com/mrliptontea/PurpleMine2/workflows/Run%20linters/badge.svg) [![Issues](https://img.shields.io/github/issues/mrliptontea/PurpleMine2.svg)](https://github.com/mrliptontea/PurpleMine2/issues) --- - -![Screenshot](https://github.com/mrliptontea/PurpleMine2/raw/master/screenshots/issues.png) - -It's written in [SCSS]. It uses [normalize.css] and benefits from some parts of [Bootstrap][bootstrap-sass] like mixins, structure, and stuff. - -## Main features - -* Bigger, easier to read fonts, -* Github-like wiki content look, -* Sidebar moved to the left for better ergonomy, -* Coloring trackers links (on lists, issue pages and even in the wiki content), -* Jira-inspired priority icons, -* Toggling sidebar visibility, -* Easy to customize via variables. - -## How install it - -To install PurpleMine, just download [.zip](https://github.com/mrliptontea/PurpleMine2/archive/master.zip) and unpack it to your Redmine's `public/themes` folder. - -Then go to Redmine > Administration > Settings > Display and select PurpleMine2 from the list and save the changes. - -## Plugins - -This theme also features a new look for [Redmine Backlogs][redmine_backlogs] plugin. To install it, simply copy stylesheets from `PurpleMine2/plugins/redmine_backlogs` and overwrite files in `{redmine}/plugins/redmine_backlogs/assets/stylesheets` and restart Redmine. - -Also, [Redmine Time Tracker][redmine_time_tracker] and [Redmine People][redmine_crm_people] plugins should look nice with PurpleMine. - ## How to customize it -If you want to customize PurpleMine to your needs, first, make sure that you have installed [node.js](http://nodejs.org/) and `npm` is available in your terminal. - -Then, from the directory that contains PurpleMine run: - - npm install - -Now all the dependencies should be ready to use. Run one more command: - - npm run watch +**dependencies:** [node.js](node.js) -And now the grunt is watching for changes in files placed in `src/` folder. Just change what you need, and it'll run Sass preprocessor automatically. +- Install dev dependencies: -Regrettably, optional file include is not possible in Sass, so I would recommend creating a new file, e.g. `src/sass/_custom-variables.scss` and importing it a the beginning of the `application.scss` file. That way all the variables with the `!default` flag could be overridden. + `npm install` -The path `src/sass/_custom-variables.scss` is added to `.gitignore` so it should make upgrading PurpleMine with keeping your changes rather painless, given that the only thing you changed in PurpleMine's source was adding this one line with `@import "custom-variables";`. +- Run file watcher + scss preprocessor (changes made to `src/` are compiled automatically) -If you need to customize styles for [Redmine Backlogs][redmine_backlogs] remember to include your `_custom-variables.scss` in `src/sass/plugins/redmine_backlogs/_common.scss`. + `npm run watch` -## Changelog +- Run browsersync proxy server to view changes in real-time. Edit [bs.js](bs.js) to relect current settings then run: -[Changelog](./CHANGELOG.md). + `node bs.js` -[SCSS]: http://sass-lang.com/ -[normalize.css]: https://github.com/necolas/normalize.css -[bootstrap-sass]: https://github.com/twbs/bootstrap-sass -[redmine_backlogs]: https://github.com/backlogs/redmine_backlogs -[redmine_time_tracker]: https://github.com/hicknhack-software/redmine_time_tracker -[redmine_crm_people]: http://www.redminecrm.com/projects/people/ -[stuff_to_do]: https://github.com/raafael911/stuff_to_do_plugin