Separate license and version from docs

_docs/gen.go

@@ -23,27 +23,37 @@ import (
 	"os"
 	"path/filepath"
 	"regexp"
+	"strings"
 )
 
 const (
 	outputPath   = "public/index.html"
-	templatePath = "index_tmpl.html"
+	templatePath = "index.tmpl.html"
 )
 
-// TODO: License should be on another file
+var license = ""
-const license = `Copyright 2014 Hajime Hoshi
 
-Licensed under the Apache License, Version 2.0 (the "License");
+func init() {
-you may not use this file except in compliance with the License.
+	b, err := ioutil.ReadFile("../license.txt")
-You may obtain a copy of the License at
+	if err != nil {
+		panic(err)
+	}
+	license = string(b)
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	// TODO: Year check
+}
 
-Unless required by applicable law or agreed to in writing, software
+var stableVersion = ""
-distributed under the License is distributed on an "AS IS" BASIS,
+
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+var devVersion = ""
-See the License for the specific language governing permissions and
+
-limitations under the License.`
+func init() {
+	b, err := ioutil.ReadFile("../version.txt")
+	if err != nil {
+		panic(err)
+	}
+	devVersion = string(b)
+}
 
 func comment(text string) template.HTML {
 	// TODO: text should be escaped
@@ -86,6 +96,17 @@ func (e *example) Source() string {
 	return str
 }
 
+func versions() string {
+	vers := []string{}
+	if stableVersion != "" {
+		vers = append(vers, "Stable: "+stableVersion)
+	}
+	if devVersion != "" {
+		vers = append(vers, "Development: "+devVersion)
+	}
+	return strings.Join(vers, ", ")
+}
+
 func main() {
 	f, err := os.Create(outputPath)
 	if err != nil {
@@ -102,6 +123,7 @@ func main() {
 	if err != nil {
 		log.Fatal(err)
 	}
+
 	examples := []example{
 		{Name: "blocks"},
 		{Name: "hue"},
@@ -111,6 +133,7 @@ func main() {
 	}
 	data := map[string]interface{}{
 		"License":  license,
+		"Versions": versions(),
 		"Examples": examples,
 	}
 	if err := t.Funcs(funcs).Execute(f, data); err != nil {

_docs/index.tmpl.html

@@ -19,9 +19,9 @@ table.examples td.code pre {
   height: 240px;
   overflow: auto;
 }
-
 </style>
-<h1>Ebiten (海老天) v1.0.0-alpha</h1>
+<h1>Ebiten (海老天)</h1>
+<p>{{.Versions}}</p>
 <ul>
   <li>A simple SNES-like 2D game library in Go</li>
   <li>Works on

_docs/public/index.html

@@ -11,7 +11,8 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.-->
+limitations under the License.
+-->
 <link rel="shortcut icon" href="./favicon.png" type="image/png" >
 <link rel="icon" href="./favicon.png" type="image/png" >
 <title>Ebiten - A simple SNES-like 2D game library in Go</title>
@@ -31,9 +32,10 @@ table.examples td.code pre {
   height: 240px;
   overflow: auto;
 }
-
 </style>
-<h1>Ebiten (海老天) v1.0.0-alpha</h1>
+<h1>Ebiten (海老天)</h1>
+<p>Development: 1.0.0-alpha
+</p>
 <ul>
   <li>A simple SNES-like 2D game library in Go</li>
   <li>Works on
@@ -299,4 +301,5 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an &#34;AS IS&#34; BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.</code></pre>
+limitations under the License.
+</code></pre>

license.txt

@@ -0,0 +1,13 @@
+Copyright 2014 Hajime Hoshi
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

readme.md

@@ -1,4 +1,4 @@
-# Ebiten (海老天) v1.0.0-alpha
+# Ebiten (海老天)
 
 [![Build Status](https://travis-ci.org/hajimehoshi/ebiten.svg?branch=master)](https://travis-ci.org/hajimehoshi/ebiten)
 
@@ -53,18 +53,4 @@
 
 ## License
 
-```
+See license.txt.
-Copyright 2014 Hajime Hoshi
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-```

version.txt

@@ -0,0 +1 @@
+1.0.0-alpha