Introduce README.md

README.md

@@ -0,0 +1,37 @@
+---
+---
+
+# Introduction
+
+This README lives at https://github.com/springframework/gh-pages#readme.
+If you're seeing it within a specific Spring project's 'gh-pages' branch, that's
+because this file, along with other files gets periodically merged in order to
+share common content like headers and footers, CSS, etc.
+
+If you're reading this file 
+
+## How to start a new 'gh-pages' Project page
+From within your Spring project's git checkout directory:
+
+    git remote add gh-pages-upstream https://github.com/springframework/gh-pages.git
+    git checkout --orphan gh-pages
+    git pull gh-pages-upstream gh-pages
+
+
+## Create _config.yml file and add update your project info
+For example:
+
+    name: Spring Data JPA
+    baseurl: /spring-data-jpa
+
+## Create index.html</h2>
+1. Copy common-index.html to index.html
+2. Add your content
+
+## Commit your changes
+    git push origin gh-pages
+
+
+# How to keep common gh-pages content up to date
+    git checkout gh-pages
+    git pull --no-ff gh-pages-upstream gh-pages

common.html

@@ -1,66 +0,0 @@
----
-layout: default
-title: {{ site.project_name }}
----
-
-<div class="billboard--wrapper project-header--wrapper">
-  <div class="billboard--container">
-    <div class="container-fluid">
-      <div  class="content--title">
-        <a href="/">Projects</a>
-      </div>
-      <div class="row-fluid">
-        <div class="span8">
-          <div class="project--links--container">
-            <a href="#" class="project-link">
-              <i class="icon-github"></i>
-            </a>
-            <a href="#">
-              <div class="icon icon-forum"></div>
-            </a>
-          </div>
-          <div class="project--title">{{ site.project_name }}</div>
-
-          <div class="project--description">
-            <h2>To start a new 'gh-pages' Project page</h2>
-            From within your Spring project's git checkout directory:
-            <pre>
-git remote add gh-pages-common https://github.com/springframework/common.git
-git checkout --orphan gh-pages
-git pull gh-pages-common gh-pages
-            </pre>
-
-            <h2>Edit _config.yml file and add update your project info</h2>
-            For example:
-            <pre>
-name: Spring Data JPA
-baseurl: /spring-data-jpa
-            </pre>
-
-            <h2>Create index.html</h2>
-            <ol>
-              <li>Copy this file (common.html) to index.html</li>
-              <li>Delete these instructions</li>
-              <li>Add your own content</li>
-            </ol>
-
-            <h2>Commit your changes</h2>
-            <pre>
-git push origin gh-pages
-            </pre>
-
-            <h2>To update common content</h2>
-            <pre>
-git checkout gh-pages
-git pull --no-ff gh-pages-common gh-pages
-            </pre>
-          </div>
-          <div class="btn btn-black uppercase">Quick Start</div>
-        </div>
-      </div>
-
-    </div>
-  </div>
-  <div class="billboard-bg spring-data--bg"></div>
-</div> 
-<div class="billboard-body--wrapper"></div>

index-common.html

@@ -0,0 +1,35 @@
+---
+layout: default
+title: {{ site.project_name }}
+---
+
+<div class="billboard--wrapper project-header--wrapper">
+  <div class="billboard--container">
+    <div class="container-fluid">
+      <div  class="content--title">
+        <a href="/">Projects</a>
+      </div>
+      <div class="row-fluid">
+        <div class="span8">
+          <div class="project--links--container">
+            <a href="#" class="project-link">
+              <i class="icon-github"></i>
+            </a>
+            <a href="#">
+              <div class="icon icon-forum"></div>
+            </a>
+          </div>
+          <div class="project--title">{{ site.project_name }}</div>
+
+          <div class="project--description">
+            YOUR CONTENT HERE
+          </div>
+          <div class="btn btn-black uppercase">Quick Start</div>
+        </div>
+      </div>
+
+    </div>
+  </div>
+  <div class="billboard-bg spring-data--bg"></div>
+</div> 
+<div class="billboard-body--wrapper"></div>