docs: update readme & download_assets script

Author: hoffstadt

README.md

@@ -27,7 +27,36 @@
 </p>
 
 ## Information
-This is currently a project I use as a starting point for various other projects. It may not be the friendliest to newcomers (yet!) but that will improve with time as higher level extensions are created and documentation improves. More information can be found in the [wiki](https://github.com/PilotLightTech/pilotlight/wiki#what-is-pilot-light). 
+Pilot Light is a lightweight real-time application framework for building native tools,
+graphics experiments, prototypes, and small engine-style applications with minimal dependencies.
+
+It is written primarily in C, uses a modular extension system, and currently includes
+platform, graphics, UI, asset, math, ECS, and many other extensions.
+
+The fastest way to try Pilot Light is to follow the instructions [here](https://github.com/PilotLightTech/pilotlight/wiki/Building).
+
+> Status: active development. APIs are stabilizing, but some systems may still change.
+
+## Quick Start
+
+The fastest way to use Pilot Light is to generate a small standalone project.
+
+### Requirements
+
+- Python 3
+- Platform requirements:
+  - Windows: Visual Studio toolchain + Vulkan SDK
+  - Linux: GCC/Clang + Vulkan SDK + X11/XCB dependencies
+  - MacOS: Xcode command line tools + Vulkan SDK
+
+### Create new project
+
+From the root of this repository:
+
+```bash
+python scripts/new_project.py ../MyFirstProject
+```
+Then just run your platforms build script located in the **/src** directory of your new project. The binaries will be located in the **/out** directory. The Pilot Light directory is no longer needed. Running the script again will update your project with the newest Pilot Light files.
 
 ## Developer Notes
 Information for developers can be found in the [wiki](https://github.com/PilotLightTech/pilotlight/wiki). This includes:

docs/documentation.md

@@ -31,12 +31,6 @@ As the name suggests (Pilot Light), the project is meant to be a starting point
 
 In the ideal situation, everything would be [STB style](https://github.com/nothings/stb) libraries which are about as decoupled as things can be. In reality, this obviously isn't possible for everything, but the effort is still made when possible, and those libraries end up in the [libs](https://github.com/PilotLightTech/pilotlight/tree/master/libs) folder. These are standalone libraries that can easily be dropped into any project. Everything else becomes an extension.
 
-## Getting Started
-
-Follow the instructions found [here](https://github.com/PilotLightTech/pilotlight/wiki/Building).
-
-Then start experimenting with the [examples](https://github.com/PilotLightTech/pilotlight/tree/master/examples).
-
 ## Architecture
 The overall architecture takes inspiration from the now nonexistent **The Machinery** game engine. This architecture is very plugin (what I call extension) based. If something can be an extension, then it should be! Functionality is provided by **APIs** which are just structs of function pointers.
 

scripts/download_assets.py

@@ -3,6 +3,15 @@
 from urllib.request import urlretrieve
 from zipfile import ZipFile
 
+if len(sys.argv) <= 1:
+    print("Pilot Light - Download Assets Script");
+    print("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
+    print("Usage: python download_assets.py [options]");
+    print("\nOptions:");
+    print("        -gltf     gltf-samples repo");
+    print("        -dev      extra pilot light assets");
+    exit()
+
 def reporthook(blocknum, blocksize, totalsize):
     bytesread = blocknum * blocksize
     if totalsize > 0:
@@ -31,9 +40,9 @@ def download_zip(url, filename, description):
     target_directory = sys.argv[1]
     for i in range(1, len(sys.argv)):
         print(sys.argv[i])
-        if sys.argv[i] == "development":
+        if sys.argv[i] == "-dev":
             development_assets = True
-        elif sys.argv[i] == "gltf":
+        elif sys.argv[i] == "-gltf":
             gltf_assets = True
         else:
             target_directory = sys.argv[i]