
QMSH-ENTITY-INSPECTOR

HELP

Overview

	This program is a simple 3D entity-inspector for the quick-mesh
	scripting language and procedural modelling kernel.

	You can drag and drop your scripts into this program in order to
	inspect and examine your procedural creations whilst scripting.

	Essentially this acts as a simple front-end to the command-line
	kernel and manages invocation, mesh-marshalling and rendering on
	your behalf so to minimise the overhead intrinsic to mesh-making.

	Bear in mind that you will still require a text-editor to modify
	your scripts - as well as a copy of the quick-mesh kernel.

	Note: this program is an experimental tool and may be subject to
	usability and behavioural issues. If you encounter any problems
	using this program - report them - such that they can be fixed.

	This program has been tested on Linux, Mac-OSX and Windows, as
	well as the Raspberry-Pi - however it is anticipated that some
	anomalous differences may not yet have been caught. Given the 
	range in hardware configurations that exist amongst the target
	platforms it is highly likely that some unexpected bugs may
	arise. Hopefully though it should fail-fast - or in other words:
	if something is going to go wrong it should occur almost as soon
	as the program is run for example an empty-window due to failed
	OpenGL context-creation or extension binding on an old computer.

	Note: this program aims (as much as is possible and practical)
	to be self-documenting - in the sense that (with the exception
	of a few grammar-centric capabilities) you should be able to
	grok its operation relatively quickly by intuition and active use.

	More detailed documentation (a PDF guide similar in vein to the
	kernel's and editor's) is in preparation and shall be added once
	most of the common problems have been uncovered and resolved.

	Finally: if you need a hand getting started or guidance using
	this program - or general assistance with quick-mesh - or if you
	just have questions - support is available at: support@qmsh.org

End.
