Explorar el Código

Update README.md

Daniel Salvadori hace 6 años
padre
commit
c8885050ee
Se han modificado 1 ficheros con 75 adiciones y 77 borrados
  1. 75 77
      README.md

+ 75 - 77
README.md

@@ -1,41 +1,41 @@
 
-  <p align="center"><img width="150" src="https://github.com/g3n/g3nd/blob/master/data/images/g3n_logo.png" alt="G3N Banner"/></p>
-  <p align="center">
-    <a href="https://godoc.org/github.com/g3n/engine"><img src="https://godoc.org/github.com/g3n/engine?status.svg" alt="Godoc"></img></a>
-    <a href="https://goreportcard.com/report/github.com/g3n/engine"><img src="https://goreportcard.com/badge/github.com/g3n/engine"  alt="Go Report Card"/></a>
-  </p>
-  <p><h1 align="center">G3N - Go 3D Game Engine</h1></p>
+<p align="center"><img width="150" src="https://github.com/g3n/g3nd/blob/master/data/images/g3n_logo.png" alt="G3N Banner"/></p>
+<p align="center">
+  <a href="https://godoc.org/github.com/g3n/engine"><img src="https://godoc.org/github.com/g3n/engine?status.svg" alt="Godoc"></img></a>
+  <a href="https://goreportcard.com/report/github.com/g3n/engine"><img src="https://goreportcard.com/badge/github.com/g3n/engine"  alt="Go Report Card"/></a>
+</p>
+<p><h1 align="center">G3N - Go 3D Game Engine</h1></p>
 
 **G3N** (pronounced "gen") is an OpenGL 3D Game Engine written in Go.
 It can be used to write cross-platform Go applications that show rich and dynamic 3D representations - not just games. A basic integrated GUI framework is provided, and 3D spatial audio is supported through [OpenAL](https://www.openal.org/).
 
-  ### **To see G3N in action try the [G3N demo](https://github.com/g3n/g3nd) or the [Gokoban](https://github.com/danaugrs/gokoban) award winning game.**
+### **To see G3N in action try the [G3N demo](https://github.com/g3n/g3nd) or the [Gokoban](https://github.com/danaugrs/gokoban) award winning game.**
 
-  <p align="center">
-    <img style="float: right;" src="https://raw.githubusercontent.com/g3n/g3nd/master/data/images/g3nd_screenshots.png" alt="G3ND In Action"/>
-  </p>
+<p align="center">
+  <img style="float: right;" src="https://raw.githubusercontent.com/g3n/g3nd/master/data/images/g3nd_screenshots.png" alt="G3ND In Action"/>
+</p>
 
-  ## Highlighted Projects Using G3N
+## Highlighted Projects Using G3N
 
- * [Gokoban - 3D Puzzle Game (_1st place in the 2017 Gopher Game Jam_)](https://github.com/danaugrs/gokoban)
- * [go-tsne (_dimensionality reduction particularly well suited for visualizing high-dimensional datasets_)](https://github.com/danaugrs/go-tsne)
- * [G3N Server-Side Rendering](https://github.com/moethu/webg3n)
+* [Gokoban - 3D Puzzle Game (_1st place in the 2017 Gopher Game Jam_)](https://github.com/danaugrs/gokoban)
+* [go-tsne (_dimensionality reduction particularly well suited for visualizing high-dimensional datasets_)](https://github.com/danaugrs/go-tsne)
+* [G3N Server-Side Rendering](https://github.com/moethu/webg3n)
 
-  ## Dependencies
+## Dependencies
 
-  **Go 1.8+** is required. The engine also requires the system to have an **OpenGL driver** and a **GCC-compatible C compiler**.
+**Go 1.8+** is required. The engine also requires the system to have an **OpenGL driver** and a **GCC-compatible C compiler**.
 
-  On Unix-based systems the engine depends on some C libraries that can be installed using the appropriate distribution package manager. See below for OS specific requirements.
+On Unix-based systems the engine depends on some C libraries that can be installed using the appropriate distribution package manager. See below for OS specific requirements.
 
-  ### Ubuntu/Debian-like
+### Ubuntu/Debian-like
 
     $ sudo apt-get install xorg-dev libgl1-mesa-dev libopenal1 libopenal-dev libvorbis0a libvorbis-dev libvorbisfile3
 
-  ### Fedora
+### Fedora
 
     $ sudo dnf -y install xorg-x11-proto-devel mesa-libGL mesa-libGL-devel openal-soft openal-soft-devel libvorbis libvorbis-devel glfw-devel libXi-devel
 
-  ### CentOS 7
+### CentOS 7
 
 Enable the EPEL repository:
 
@@ -43,58 +43,56 @@ Enable the EPEL repository:
 
 Then install the same packages as for Fedora - remember to use `yum` instead of `dnf` for the package installation command.
 
-  ### Windows
+### Windows
 
 The necessary audio libraries sources and DLLs are supplied but they need to be installed
 manually. Please see [Audio libraries for Windows](audio/windows) for details. We tested the Windows build using the [mingw-w64](https://mingw-w64.org) toolchain (you can download [this file](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/8.1.0/threads-posix/seh/x86_64-8.1.0-release-posix-seh-rt_v6-rev0.7z) in particular).
 
-  ### macOS
+### macOS
 
 Install the development files of OpenAL and Vorbis using [Homebrew](https://brew.sh/):
 
     brew install libvorbis openal-soft
 
-  ## Installation
+## Installation
 
-  The following set of commands will download and install the engine along with all its Go dependencies:
+The following set of commands will download and install the engine along with all its Go dependencies:
   
-  ```
-  git clone https://github.com/g3n/engine g3n-engine
-  cd g3n-engine
-  go install ./...
-  ```
-
-  ## Features
-
-  * Cross-platform: Windows, Linux, and macOS
-  * Integrated GUI (graphical user interface) with many widgets
-  * Hierarchical scene graph - nodes can contain other nodes
-  * 3D spatial audio via OpenAL (.wav, .ogg)
-  * Real-time lighting: ambient, directional, point, and spot lights
-  * Physically-based rendering: fresnel reflectance, geometric occlusion, microfacet distribution
-  * Model loaders: glTF (.gltf, .glb), Wavefront OBJ (.obj), and COLLADA (.dae)
-  * Geometry generators: box, sphere, cylinder, torus, etc...
-  * Geometries support morph targets and multimaterials
-  * Support for animated sprites based on sprite sheets
-  * Perspective and ortographic cameras
-  * Text image generation and support for TrueType fonts
-  * Image textures can be loaded from GIF, PNG or JPEG files
-  * Animation framework for position, rotation, and scale of objects
-  * Support for user-created GLSL shaders: vertex, fragment, and geometry shaders
-  * Integrated basic physics engine (experimental/incomplete)
-  * Support for HiDPI displays
-
-  <p align="center">
-    <img style="float: right;" src="https://github.com/g3n/g3n.github.io/raw/master/img/g3n_banner_small.png" alt="G3N Banner"/>
-  </p>
-
-  ## Hello G3N
-
-  The code below is a basic "hello world" application 
-  ([hellog3n](https://github.com/g3n/demos/tree/master/hellog3n))
-  that shows a blue torus and a button that when clicked makes the torus red:
-
-  ```Go
+```
+git clone https://github.com/g3n/engine g3n-engine
+cd g3n-engine
+go install ./...
+```
+
+## Features
+
+* Cross-platform: Windows, Linux, and macOS. (WebAssembly is 90% complete!)
+* Integrated GUI (graphical user interface) with many widgets
+* Hierarchical scene graph - nodes can contain other nodes
+* 3D spatial audio via OpenAL (.wav, .ogg)
+* Real-time lighting: ambient, directional, point, and spot lights
+* Physically-based rendering: fresnel reflectance, geometric occlusion, microfacet distribution
+* Model loaders: glTF (.gltf, .glb), Wavefront OBJ (.obj), and COLLADA (.dae)
+* Geometry generators: box, sphere, cylinder, torus, etc...
+* Geometries support morph targets and multimaterials
+* Support for animated sprites based on sprite sheets
+* Perspective and ortographic cameras
+* Text image generation and support for TrueType fonts
+* Image textures can be loaded from GIF, PNG or JPEG files
+* Animation framework for position, rotation, and scale of objects
+* Support for user-created GLSL shaders: vertex, fragment, and geometry shaders
+* Integrated basic physics engine (experimental/incomplete)
+* Support for HiDPI displays
+
+<p align="center">
+  <img style="float: right;" src="https://github.com/g3n/g3n.github.io/raw/master/img/g3n_banner_small.png" alt="G3N Banner"/>
+</p>
+
+## Hello G3N
+
+The code below is a basic "hello world" application ([hellog3n](https://github.com/g3n/demos/tree/master/hellog3n)) that shows a blue torus and a button that when clicked makes the torus red:
+
+```Go
 package main
 
 import (
@@ -175,33 +173,33 @@ func main() {
 		renderer.Render(scene, cam)
 	})
 }
-  ```
+```
 
-  <p align="center">
-    <img style="float: right;" src="https://github.com/g3n/demos/blob/master/hellog3n/screenshot.png" alt="hellog3n Screenshot"/>
-  </p>    
+<p align="center">
+  <img style="float: right;" src="https://github.com/g3n/demos/blob/master/hellog3n/screenshot.png" alt="hellog3n Screenshot"/>
+</p>    
   
-  You can download and install `hellog3n` via:
+You can download and install `hellog3n` via:
     
     go get -u github.com/g3n/demos/hellog3n
 
-  For more complex demos please see the [G3N demo program](https://github.com/g3n/g3nd).
+For more complex demos please see the [G3N demo program](https://github.com/g3n/g3nd).
 
-  ## Documentation
+## Documentation
 
-  The complete engine API reference can be found here: [![GoDoc](https://godoc.org/github.com/g3n/engine?status.svg)](https://godoc.org/github.com/g3n/engine).
+The complete engine API reference can be found here: [![GoDoc](https://godoc.org/github.com/g3n/engine?status.svg)](https://godoc.org/github.com/g3n/engine).
 
-  There is also the beginning of a Getting Started Guide, and a newly created list of Guides and Tutorials:
+There is also the beginning of a Getting Started Guide, and a newly created list of Guides and Tutorials:
 
-  * [Getting Started](https://github.com/g3n/engine/wiki/Getting-Started-(WIP))
-  * [Guides and Tutorials](https://github.com/g3n/engine/wiki/Guides-and-Tutorials)
+* [Getting Started](https://github.com/g3n/engine/wiki/Getting-Started-(WIP))
+* [Guides and Tutorials](https://github.com/g3n/engine/wiki/Guides-and-Tutorials)
 
-  Along with those, a good way to learn how to use the engine is to see the source code of [G3ND - the G3N demo](https://github.com/g3n/g3nd).
+Along with those, a good way to learn how to use the engine is to see the source code of [G3ND - the G3N demo](https://github.com/g3n/g3nd).
   
-  ## Contributing
+## Contributing
 
-  If you find a bug or create a new feature you are encouraged to send pull requests!
+If you find a bug or create a new feature you are encouraged to send pull requests!
 
-  ## Community
+## Community
 
-  Join our [channel](https://gophers.slack.com/messages/g3n) on Gophers Slack ([Click here to register for Gophers Slack](https://invite.slack.golangbridge.org/)). It's a great way to have your questions answered quickly by the G3N community.
+Join our [channel](https://gophers.slack.com/messages/g3n) on Gophers Slack ([Click here to register for Gophers Slack](https://invite.slack.golangbridge.org/)). It's a great way to have your questions answered quickly by the G3N community.