Skip to content

Commit

Permalink
Added High Level Roadmap details, and reorganized the docs directory
Browse files Browse the repository at this point in the history
  • Loading branch information
robertosfield committed Oct 18, 2018
1 parent 86bd056 commit 1dd0852
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
@@ -1,5 +1,31 @@
VulkanSceneGraphPrototype (VSG) is a prototype for a modern scene graph library built upon Vulkan graphics/compute API. The software is written in C++17, and follows the [CppCoreGuidlines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines). The source code is published under the [MIT License](LICENSE.md).

## High level Roadmap

### 1. Exploration Phase, June-September 2018 (completed)
>**Goal : Establsih which technologies and board techniques to use**
>Learn and experiment with Vulkan, modern C++, and possible 3rd party dependencies.
>Experimenting with different approaches to object/scene graph design and implementation
>Resources associated with ExplorationPhase work:
> * [Areas of Interest](docs/ExplorationPhase/AreasOfInterest.md)
> * [3rd Party Resources](docs/ExplorationPhase/3rdPartyResources.md)
### 2. Prototype Phase, October-December 2018 (present work)
>**Goal : Rapid prototyping of main classes, library and test applications to establish how the scene graph API will broadly look and work.**
>Develop as a throw away prototype, but keep in mind that not not of functionality is being prototyped, but scoping out the work practices that will work best once work on the final software starts.
### 3. Core Development Work, January-Summer 2019
>**Goal: Implement the final class interfaces and implemetation**
>Using the protyping work as a guide implement the final scene graph library with the aim of creatig a solid interface and implementation.
### 4. Release Work, Fall 2019 onwards
>**Goal: Test scene graph library against real-world applications and shake down the API and implementation for it's first stable release.**
## Prerequisites
* C++17 complient compiler i.e. g++ 7.3 or later, Clang 6.0 or later, Visual Studio S2017 or later.
* [Vulkan](https://vulkan.lunarg.com/) 1.1 or later.
Expand Down Expand Up @@ -64,6 +90,3 @@ Three examples within the vsgFramework project that may be of paricular interest
* [vulkan_minimal_compute](https://github.com/Erkaman/vulkan_minimal_compute) tutorial ported to VSG [vsgFramework/applications/vsgcompute](https://github.com/robertosfield/vsgFramework/blob/master/applications/vsgcompute/vsgcompute.cpp)


## General background documents used in dev process
* [Areas of Interest](docs/AreasOfInterest.md)
* [3rd Party Resources](docs/3rdPartyResources.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 1dd0852

Please sign in to comment.