소스 검색

Improving github docs a bit

BearishSun 9 년 전
부모
커밋
95ad09fb92
7개의 변경된 파일44개의 추가작업 그리고 25개의 파일을 삭제
  1. 18 4
      Documentation/GitHub/compiling.md
  2. 0 1
      Documentation/GitHub/features.md
  3. 3 1
      Documentation/GitHub/install.md
  4. 3 6
      Documentation/GitHub/license.md
  5. 3 3
      Documentation/GitHub/roadmap.md
  6. 1 1
      Doxyfile
  7. 16 9
      README.md

+ 18 - 4
Documentation/GitHub/compiling.md

@@ -1,9 +1,23 @@
 # Compiling
 
-Banshee compiles on VS2015 - earlier versions might work with minor modifications. Other Windows compilers might work but have not been tested. Support for more platforms and compilers will become available with time.
+Supported compilers:
+ - MSVC++ 14.0 (Visual Studio 2015)
+ - Clang
 
-Aside from Banshee source code you will also need various third party dependencies. You may retrieve/compile those dependencies yourself by following a guide in "CompilingDependenciesManually.txt". If you are using VS2015 you can avoid compiling dependencies by downloading the archive below, containing a set of pre-compiled dependencies. These should be extracted in the root of the directory containing Banshee source code.
+Supported platforms:
+ - Windows
+ - Mac/Linux COMING SOON
+ 
+VS2015 solution is provided by default, as well as a CMake lists file which can be used for generating non-VS builds.
 
-The archive below also contains all non-code resources (images, shaders) required for the editor, engine and example projects.
+# Third party dependencies
+Aside from Banshee source code you will also need various third party dependencies. You may retrieve/compile those dependencies yourself by following a guide in "CompilingDependenciesManually.txt" (provided with the source code). 
 
-[Download dependencies (VS2015)] (http://bearishsun.thalassa.feralhosting.com/BansheeDependencies_VS2015_v0.2.0.zip) 
+Optionally, if you are using VS2015 you can avoid compiling dependencies by downloading the archive below, containing a set of pre-compiled dependencies. These should be extracted in the root of the directory containing Banshee source code.
+
+[Download dependencies (VS2015)] (http://bearishsun.thalassa.feralhosting.com/BansheeDependencies_VS2015_v0.3.0.zip)
+
+# Data files
+You will also need data files (non-code resources like images, shaders, etc.) in order to run the editor, engine and example projects.
+
+[Download data files] (http://bearishsun.thalassa.feralhosting.com/BansheeData_v0.3.0.zip)

+ 0 - 1
Documentation/GitHub/features.md

@@ -2,7 +2,6 @@
 
 All features listed here are the ones currently available (implemented). If you are interested in what's coming up in the near future check out our [roadmap](roadmap.md).
   
-Current version: **v0.3**
 ---------------------------------------------------  
   
 ## Core

+ 3 - 1
Documentation/GitHub/install.md

@@ -2,4 +2,6 @@
 
 Banshee is still in development and does not yet come with a proper installer. You will need to extract the downloaded files manually. The platform support is currently limited to Windows only, but more platforms are coming in near future.
 
-[Download binaries (Windows x64)] (http://bearishsun.thalassa.feralhosting.com/Banshee_Win_x64_v0.2.0.zip)
+The version below is the latest one, check the git releases tags for links for older ones.
+
+[Download binaries (Windows x64)] (http://bearishsun.thalassa.feralhosting.com/Banshee_Win_x64_v0.3.0.zip)

+ 3 - 6
Documentation/GitHub/license.md

@@ -11,18 +11,15 @@ A commercial license is available for those that are not comfortable with LGPL t
 
 It is available under the "pay what you want" model, meaning you can purchase it for as little as $0 or as much as $1000. This is completely up to you and we won't judge if you just want a free license.
 
-However if you like Banshee consider giving us some money as this ensures we can pay the costs for developing it further. All the money will be invested into (in the order of importance):
- - My (the author) living costs, hardware, software and services used for and by Banshee
- - Hiring more developers to help with adding more features faster (see [Roadmap](roadmap.md))
- - Hiring people to help with testing, building demos/examples, managing website, improving documentation and tutorials
+However if you like Banshee consider spending some money as this ensures we can pay the costs for developing it further. The money will be invested into hiring more developers to help with adding more features faster (see [Roadmap](roadmap.md)), as well as help with testing, polish and documentation.
  
 ## Third party licenses
-Licenses for all third party libraries used by Banshee can be found in License\ThirdParty sub-directory.
+Licenses for all third party libraries used by Banshee can be found in License\ThirdParty sub-directory of the source code.
 
 ## License FAQ
 
 *Why have two separate licenses?*
-LGPL is offered because at its core Banshee is an open source project. Commercial license is offered because we wish to fund Banshee development so we can make it bigger and better than other open source engines and to be able to compete with the big proprietary engines.  
+LGPL is offered because at its core Banshee is an open source project. Commercial license is offered because we wish to fund Banshee development so we can make it bigger and better than other open source engines.
 
 *How do I get a commercial license?*
 Until a website is set up, you must contact me personally at [email protected]

+ 3 - 3
Documentation/GitHub/roadmap.md

@@ -1,11 +1,10 @@
 # Roadmap
 
-Focus right now is to implement the most critical missing features:
- - Physics (colliders, triggers, rigidbodies, joints, character controller)
+The focus right now is to implement the most critical missing features:
  - Animation (skeletal, blend shapes, generic script variables)
  - Audio (popular file format support, music, 3D audio)
  
-The plan is to finish these roughly around mid-2016.
+These should be finished roughly around mid-2016.
 
 ---------------------------------------------------
 
@@ -28,6 +27,7 @@ There are many more features planned, but these are without a specific timeline
  - Terrain
  - Effects/Particle editor
  - AI support
+ - VR support
  - Cinematics editor
  - Higher level resource streaming support (including level and texture streaming)
  - Unified shading language

+ 1 - 1
Doxyfile

@@ -1254,7 +1254,7 @@ HTML_DYNAMIC_SECTIONS  = NO
 # Minimum value: 0, maximum value: 9999, default value: 100.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_INDEX_NUM_ENTRIES = 100
+HTML_INDEX_NUM_ENTRIES = 20
 
 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
 # generated that can be used as input for Apple's Xcode 3 integrated development

+ 16 - 9
README.md

@@ -7,20 +7,27 @@ The scripting system supports C# and comes with an extensive API ensuring you ca
 
 Aside from being a fully featured game engine and toolkit, Banshee also aims to provide a **high quality foundation**, so others may build and improve upon it. This is reflected in Banshee's architecture which is split into multiple layers allowing developers to use only the functionality they needed, as well as its plugin oriented nature which allows developers to fully remove or replace major engine systems. You will find that Banshee's code is modern, with clean interfaces that make it easy to learn and maintain. Platform specific functionality is kept at a minimum making porting as easy as possible. Additionally its codebase is fully documented with an extensive API reference, as well as a set of manuals introducing you to most major systems.
 
-# Learn more
-* [Features](Documentation/GitHub/features.md)
-* [Roadmap](Documentation/GitHub/roadmap.md)
-* [Download](Documentation/GitHub/install.md)
-* [Compiling](Documentation/GitHub/compiling.md)
-* [Documentation](Documentation/GitHub/documentation.md)
-* [License](Documentation/GitHub/license.md)
+# Features
+* [Features](Documentation/GitHub/features.md) - A list of all currently available features.
+* [Roadmap](Documentation/GitHub/roadmap.md) - A list of features to be implemented in both near and far future.
+
+# Download
+* [Binaries](Documentation/GitHub/install.md) - Download pre-built binaries for the most recent version.
+* [Compiling](Documentation/GitHub/compiling.md) - Learn how to compile the engine yourself.
+
+# Documentation
+* [Managed](Documentation/GitHub/documentation.md) - Documentation for the scripting (C#) API. This is what most users will be interested in.
+* [Native] (Documentation/GitHub/documentation.md) - Documentation for the native (C++) API. This is meant for advanced users meaning to extend/modify the engine.
+* [License](Documentation/GitHub/license.md) - Information about Banshee's license.
 
 # Media
+**Banshee Editor**
 ![Banshee Editor](http://bearishsun.thalassa.feralhosting.com/BansheeEditor.png "Banshee Editor")
 
-[Editor video overview] (https://youtu.be/WJsYOyCXGEU)
+**Video overview**
+[Link] (https://youtu.be/WJsYOyCXGEU)
 
-# About
+# Author
 Banshee was created and is developed by Marko Pintera. The goal of Banshee is to create a high quality open source game engine that is intuitive to use and easy to extend.
 
 I'm happy to connect with other developers, feel free to contact me at [e-mail] (http://scr.im/39d1) or add me on [LinkedIn] (https://goo.gl/t6pPPs).