git.maemo.org Git - apps-fullscreen/blob - www/README.md

   1 # About
   2
   3 A clean concise theme for your GitHub projects from [Fublo](http://fublo.net). You can see a working example [here](http://fublo.github.com/gh-pages-theme).
   4
   5 The theme uses skeleton to provide a responsive layout so even looks great on mobile devices!
   6
   7 It comes with a download button, syntax highlighting and a section at the bottom to credit yourself with.
   8
   9 # Installation
  10
  11 To install the theme to the `gh-pages` branch of your repository just run the following line. Remember, this will create a new branch called `gh-pages` wiping any current branch called `gh-pages`.
  12
  13     git remote add gh-pages-theme git@github.com:fublo/gh-pages-theme.git; git fetch gh-pages-theme; git checkout -b gh-pages gh-pages-theme/master;
  14
  15 Alternatively you can just [download and extract this zip](https://github.com/fublo/gh-pages-theme/zipball/master).
  16
  17 So this will:
  18
  19  * Add the remote `gh-pages-theme` which points to the themes repository.
  20  * Fetch the repository.
  21  * Create the new branch `gh-pages` from the fetched data.
  22
  23 # Configuration
  24
  25 You will need to configure the following elements.
  26
  27  * The GitHub ribbons - Located near the bottom of the HTML. You can change the colour and link
  28  * The download button link
  29  * The pages title tag
  30  * All content, examples, descriptions etc. Leaving lorum ipsum laying about does not look good. This includes the first part of the footer, please leave the very last line.
  31
  32 # Compatibility
  33
  34 Works perfectly in the following browsers.
  35
  36  * Chrome
  37  * Firefox 4+ (syntax highlighting is broken below)
  38  * Safari
  39  * Opera
  40  * Internet Explorer 7+ (6 begins to break down with image transparency and alignment issues)
  41
  42 # Licence
  43
  44 A clean concise theme for your GitHub projects
  45
  46 Copyright (C) 2011 Fublo Ltd
  47
  48 This program is free software: you can redistribute it and/or modify
  49 it under the terms of the GNU General Public License as published by
  50 the Free Software Foundation, either version 3 of the License, or
  51 (at your option) any later version.
  52
  53 This program is distributed in the hope that it will be useful,
  54 but WITHOUT ANY WARRANTY; without even the implied warranty of
  55 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  56 GNU General Public License for more details.
  57
  58 You should have received a copy of the GNU General Public License
  59 along with this program.  If not, see <http://www.gnu.org/licenses/gpl.html>.