diff --git a/README b/README index 3c886c43a..26e2ef346 100644 --- a/README +++ b/README @@ -222,15 +222,19 @@ can be used: Creating pgAdmin themes ----------------------- -To create a pgAdmin theme, you need to create a directory under web/pgadmin/static/scss/resources. -Copy the sample file _theme.variables.scss.sample to the new directory and rename it to _theme.variables.scss. -Change the desired hexadecimal values of the colors and bundle pgAdmin. You can also add a preview image in the -theme directory with the name as _preview.png. It is recommended that the preview image should not be -larger in size as it may take time to load on slow networks. Run the yarn run bundle and you're good to go. -No other changes are required, pgAdmin bundle will read the directory and create other required entries to make them -available in preferences. -The name of the theme is derived from the directory name. Underscores (_) and hyphens (-) will be replaced with -spaces and the result will be camel cased. +To create a pgAdmin theme, you need to create a directory under +web/pgadmin/static/scss/resources. +Copy the sample file _theme.variables.scss.sample to the new directory and +rename it to _theme.variables.scss. Change the desired hexadecimal values of +the colors and bundle pgAdmin. You can also add a preview image in the theme +directory with the name as _preview.png. It is recommended that the +preview image should not be larger in size as it may take time to load on slow +networks. Run the yarn run bundle and you're good to go. No other changes are +required, pgAdmin bundle will read the directory and create other required +entries to make them available in preferences. + +The name of the theme is derived from the directory name. Underscores (_) and +hyphens (-) will be replaced with spaces and the result will be camel cased. Configuring the Runtime -----------------------