Browse Source

added instructions for the custom colour file

sirjeff 4 tuần trước cách đây
mục cha
commit
14d84cad98
1 tập tin đã thay đổi với 20 bổ sung5 xóa
  1. 20 5
      README.md

+ 20 - 5
README.md

@@ -49,8 +49,8 @@ In a terminal window ( or command for Windoze ) browse/cd to your Kanboard `plug
 ### GUI
 ### GUI
 
 
 Download either zip file :  
 Download either zip file :  
-* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip](https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip)
-* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz](https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz)
+* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip](/ominz/OMIProjectBranding/archive/main.zip)
+* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz](/ominz/OMIProjectBranding/archive/main.tar.gz)
 
 
 and uncompress/unzip/untar into your Kanboard `plugins` directory  
 and uncompress/unzip/untar into your Kanboard `plugins` directory  
 
 
@@ -67,8 +67,23 @@ This message will change when the code is finalised :)
 
 
 Use the "Branding" link in the left hand menu when you're in a project.  
 Use the "Branding" link in the left hand menu when you're in a project.  
 You can modify the logo per project by entering an image URL ( no upload possible here ) into the 'Logo URL' field.  
 You can modify the logo per project by entering an image URL ( no upload possible here ) into the 'Logo URL' field.  
-The 'Accent Color' colour currently underlines the logo and that's all. It was just part of a PoC.  
-Still WiP so check back later :)  
+The header colours, background and foreground can also be modified, via a dropdown list of built in colours and custom colours that you can add yourself [See the 'Custom Colours File' below](#custom-colours-file).  
+
+## Custom Colours File
+
+The dropdown colour picker uses a built in list, which has a limited number of colours.  
+This plugin adds a set of custom colours to this list, and also allows you to modify the list so you can add your own colours.  
+The list is a simple Name=Value style text file called `OMIProjectBrandingColours.txt` living in your data folder.  
+It goes, **friendly colour name**=**css colour**   
+e.g.  
+```css
+Light-as Yellow=#ff9
+White=#fff
+This is also white=#ffffff
+HoT PinK=hotpink
+Faded Red=rgba(255,0,0,0.5)
+```  
+Don't forget to back this file up if you upgrade your Kanboard.  
 
 
 ## Compatibility 
 ## Compatibility 
 Compatibility with other Plugins.  
 Compatibility with other Plugins.  
@@ -76,7 +91,7 @@ So far I've used it successfully with Customizer, and WeKanboard.
 It will override the global logo ( which is the point of this plugin ) in the header when you're in a project.  
 It will override the global logo ( which is the point of this plugin ) in the header when you're in a project.  
 
 
 Please let me know if there are any issues with the header styles, when using other plugins.  
 Please let me know if there are any issues with the header styles, when using other plugins.  
-[You can add issues here.](/ominz/OMIProjectBranding/issues)  
+[You can add issues here.](/ominz/OMIProjectBranding/issues/)  
 
 
 
 
 ## Maintainers
 ## Maintainers