Permalink
Browse files

Update README

  • Loading branch information...
1 parent 2910c3a commit de841ebcbf7f037194bd7874844502dd06cc95fd @knewter knewter committed Feb 27, 2012
Showing with 22 additions and 0 deletions.
  1. +22 −0 README.md
View
@@ -2,6 +2,11 @@
This is a project to house a stylesheet that will make Jenkins look prettier
than the default.
+At [isotope|eleven][isotope] we use [Jenkins CI][jenkins] for our continuous
+integration server. This is all good, but I kind of hate how it looks. So I
+built an open source project (it's what you do, right?) wherein I style it up
+using [Sass][sass].
+
### Screenshots
Here's an example of what this project will make your jenkins look like
@@ -12,6 +17,18 @@ Here's an example of what this project will make your jenkins look like
This is what it looks like standard.
![Stock Jenkins](https://raw.github.com/isotope11/Jenkins-isotope-style/master/doc/jenkins_stock.png)
+### Using it for your organization
+So this easy for you to modify and use for your own organization. Here are the
+steps you'd need to take.
+
+1. Install the [Jenkins Simple Theme Plugin][simple_theme].
+2. Set your custom css to `http://isotope11.github.com/jenkins-isotope-style/jenkins-isotope-style.css`
+3. Fork our project, make your own changes (pull requests welcome!), add your
+organization's logo and colors.
+4. Run the ruby script provided to publish your stylesheet to github-pages for
+hosting, so you can just point your Jenkins custom CSS to your own fork.
+5. Tweak to your heart's content.
+
### Development
To run sass and compile the stylesheet as you make changes, run this:
@@ -24,3 +41,8 @@ sure you've committed and pushed everything to master. Then run:
That'll do all the git magic. Now when you ctrl+refresh jenkins, your changes
are there.
+
+[isotope]: http://www.isotope11.com
+[jenkins]: http://www.jenkins-ci.org
+[sass]: http://sass-lang.com/
+[simple_theme]: https://wiki.jenkins-ci.org/display/JENKINS/Simple+Theme+Plugin

0 comments on commit de841eb

Please sign in to comment.