Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Added Code Style and Migration guide links to manual

Lewy Blue 8 years ago
parent
b3f6870fd5
commit
b934e7e6bd
3 changed files with 44 additions and 0 deletions
Unified View Show Diff Stats
  1. 2 0
      docs/list.js
  2. 22 0
      docs/manual/introduction/Code-style-guide.html
  3. 20 0
      docs/manual/introduction/Migration-guide.html

+ 2 - 0
docs/list.js
View File 

@@ -5,6 +5,8 @@ var list = {
 
 			[ "Creating a scene", "manual/introduction/Creating-a-scene" ],
 
 			[ "Creating a scene", "manual/introduction/Creating-a-scene" ],
 
 			[ "Drawing Lines", "manual/introduction/Drawing-lines" ],
 
 			[ "Drawing Lines", "manual/introduction/Drawing-lines" ],
 
 			[ "Creating Text", "manual/introduction/Creating-text" ],
 
 			[ "Creating Text", "manual/introduction/Creating-text" ],
 
+			[ "Code Style Guide", "manual/introduction/Code-style-guide" ],
 
+			[ "Migration Guide", "manual/introduction/Migration-guide" ],
 
 			[ "Matrix transformations", "manual/introduction/Matrix-transformations" ]
 
 			[ "Matrix transformations", "manual/introduction/Matrix-transformations" ]
 
 		],
 
 		],

+ 22 - 0
docs/manual/introduction/Code-style-guide.html
View File 

@@ -0,0 +1,22 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8">
 
+		<base href="../../" />
 
+		<script src="list.js"></script>
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		<h1>[name]</a></h1>
 
+
 
+		<div class="desc">
 
+			All code and examples in three.js are written using Mr.doob's Code Style.
 
+			Of course you are free to use whatever style you prefer for your own work, but
 
+			if you are adding code to the library or examples then you must follow this guide.<br /><br />
 
+
 
+			You can find details
 
+			<a href="https://github.com/mrdoob/three.js/wiki/Mr.doob%27s-Code-Style%E2%84%A2">here</a>.
 
+		</div>
 
+	</body>
 
+</html>

+ 20 - 0
docs/manual/introduction/Migration-guide.html
View File 

@@ -0,0 +1,20 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+	<head>
 
+		<meta charset="utf-8">
 
+		<base href="../../" />
 
+		<script src="list.js"></script>
 
+		<script src="page.js"></script>
 
+		<link type="text/css" rel="stylesheet" href="page.css" />
 
+	</head>
 
+	<body>
 
+		<h1>[name]</a></h1>
 
+
 
+		<div class="desc">
 
+			The migration guide is maintained on the [link:https://github.com/mrdoob/three.js/wiki wiki].
 
+			It contains a list of changes for each version of three.js going back to r45.<br /><br />
 
+
 
+			You can find it [link:https://github.com/mrdoob/three.js/wiki/Migration here].
 
+		</div>
 
+	</body>
 
+</html>