README + Project settings

Author: willnode

.vscode/settings.json

@@ -8,5 +8,6 @@
         "-DCMAKE_CXX_COMPILER:STRING=C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.16.27023/bin/Hostx86/x64/cl.exe",
         "-DCMAKE_C_COMPILER:STRING=C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.16.27023/bin/Hostx86/x64/cl.exe",
     ],
-	"cmake.generator": "Visual Studio 15 2017"
+	"cmake.generator": "Visual Studio 15 2017",
+	"C_Cpp.clang_format_style": "{ BasedOnStyle: LLVM, UseTab: Always, IndentWidth: 4, BreakBeforeBraces: Allman, AllowShortIfStatementsOnASingleLine: false, IndentCaseLabels: false, ColumnLimit: 0, TabWidth: 4, NamespaceIndentation: All, AllowAllParametersOfDeclarationOnNextLine: true }"
 }

CMakeLists.txt

@@ -4,10 +4,6 @@ project("forth")
 
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
 
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)
-
 set(forth_version 0.1)
 
 add_subdirectory(source)

README.md

@@ -1,2 +1,23 @@
-# forth-library
-Forth Core C++ Library
+# Forth-Library
+
+> ⚠ WARNING: This library's current state is in heavy development ⚠
+
+Forth Engine's Core C++ Library
+
+Forth-Library is a Library to manipulate four dimensional objects via Cross Sectional Projection. My biggest motivation to create this library is to have my asset [Engine4](https://assetstore.unity.com/packages/tools/modeling/engine-4-34475) moving away from Unity. Creating one more degree of freedom to create higher-dimensional gaming to interested parties.
+
+Forth-Library is part of higher project *Forth Engine*. Forth Engine is not just about displaying higher dimensional objects: There will be Physics, Scene Management, Import/Export, Graphics Patches, The Editor, etc.. It's future aim is to became a full blown Independent Game Engine.
+
+Playable demos is at [Forth-Engine/demo](https://github.com/forth-engine/demo)
+
+# Prelease Checklist
+
++ ✅ Core Rendering Library
++ ⌛ Full OpenGL integration
++ ⌛ Physics Library
++ ⌛ FOBJ (Forth-OBJ File) Import/Export
++ ⌛ ...etc...
+
+# LICENSE
+
+[GPLv3](LICENSE). This could change in future but currently we want to motivate parties who like to do researches rather than those who do commercial.