Skip to content

Commit

Permalink
SAK-32257 Moved Morpheus readme to library. (sakaiproject#3994)
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianfish authored Mar 1, 2017
1 parent 85fae83 commit 9a5b5d7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions reference/README.md → library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
* **[Morpheus Hackathon video](https://www.youtube.com/watch?v=Hx7pQ52mWrc)** : starts about 3 minutes in.
* **Morpheus quick start**: Basic commands you need to know to compile and generate new skin in Sakai using Morpheus.

1. Morpheus has master theme which is located in [/reference/library/src/morpheus-master/](./library/src/morpheus-master/) which is used to generate the default theme called "*morpheus-default*".
1. Morpheus has master theme which is located in [/library/src/morpheus-master/](./library/src/morpheus-master/) which is used to generate the default theme called "*morpheus-default*".

2. To make changes to default colors you have to edit values in file *[/reference/library/src/morpheus-master/sass/_defaults.scss](./library/src/morpheus-master/sass/_defaults.scss)* (More details about default variables in **[Changing Defaults (Basics)](#defaults)** section ).
2. To make changes to default colors you have to edit values in file *[/library/src/morpheus-master/sass/_defaults.scss](./library/src/morpheus-master/sass/_defaults.scss)* (More details about default variables in **[Changing Defaults (Basics)](#defaults)** section ).

3. Master theme cannot be used directly, you have to compiling the master to get generate actual/default skin .

4. To compile the master skin you have to navigate to */reference/library/* and run command ```mvn clean install -Pcompile-skin``` which will generate the skin named is is named as "*morpheus-default*" by default.
4. To compile the master skin you have to navigate to */library/* and run command ```mvn clean install -Pcompile-skin``` which will generate the skin named is is named as "*morpheus-default*" by default.

5. To change the name of the default skin from "*morpheus-default"* to custom name (eg: custom_skin) you have to run command.
``` mvn clean install -Pcompile-skin -Dsakai.skin.target=custom_skin```
Expand All @@ -21,10 +21,10 @@

***Note the profile ```-P compile-skin``` is active by default and need not be added as a command line option.***

More commands are listed here: *[https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/compile-skin.md](https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/compile-skin.md)*
More commands are listed here: *[https://github.com/sakaiproject/sakai/blob/master/library/src/morpheus-master/compile-skin.md](https://github.com/sakaiproject/sakai/blob/master/library/src/morpheus-master/compile-skin.md)*


* <a name="defaults"></a>**Changing Defaults (Basics)**: Below are the list of some important and widely used variables for changing colors, font and other defaults located in file *[/reference/library/src/morpheus-master/sass/_defaults.scss](./library/src/morpheus-master/sass/_defaults.scss)*.
* <a name="defaults"></a>**Changing Defaults (Basics)**: Below are the list of some important and widely used variables for changing colors, font and other defaults located in file *[/library/src/morpheus-master/sass/_defaults.scss](./library/src/morpheus-master/sass/_defaults.scss)*.

1. $primary-color : This variable is used for the primary color, which is used in portal header background, tool header background, button colors, tool navigation etc.

Expand All @@ -45,7 +45,7 @@ There are lot of other variables you can refer to the *[_defaults.scss](./librar
* **How to change default tool Icons:**
Fonts/Icons in Morpheus are imported from Font-Awesome ([https://fortawesome.github.io/Font-Awesome/icons/](https://fortawesome.github.io/Font-Awesome/icons/)), this section explains how to change the default icons for the tools and also add new icon for the new tools.

1. File that maps the Font-Awesome to Morpheus Tools in the tools list and Course List is [/reference/library/src/morpheus-master/sass/base/_icons.scss](./library/src/morpheus-master/sass/base/_icons.scss)
1. File that maps the Font-Awesome to Morpheus Tools in the tools list and Course List is [/library/src/morpheus-master/sass/base/_icons.scss](./library/src/morpheus-master/sass/base/_icons.scss)

2. There are 2 sections to this file .

Expand All @@ -59,13 +59,13 @@ NOTE: Any changes or additions in one section should be changed or added in othe

* **How to change default Bootstrap styles:**

1. File that contains the default values for the bootstrap is located in *[/reference/library/src/morpheus-master/sass/base/_bootstrap-defaults.scss](./library/src/morpheus-master/sass/base/_bootstrap-defaults.scss)*
1. File that contains the default values for the bootstrap is located in *[/library/src/morpheus-master/sass/base/_bootstrap-defaults.scss](./library/src/morpheus-master/sass/base/_bootstrap-defaults.scss)*

2. By default all variables are commented out but if you want to change any variable uncomment them and change the value and compile the skin after the changes are made.

3. All necessary documentation related to the variables is located at the variable definition itself.

* **More involved:** Explaining SASS and Morpheus folder structure ( [https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/customization-tool.md](https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/customization-tool.md) )
* **More involved:** Explaining SASS and Morpheus folder structure ( [https://github.com/sakaiproject/sakai/blob/master/library/src/morpheus-master/customization-tool.md](https://github.com/sakaiproject/sakai/blob/master/library/src/morpheus-master/customization-tool.md) )

1. Tool customizations:

Expand Down

0 comments on commit 9a5b5d7

Please sign in to comment.