From 32e95489db1c6661a2596b181ed5f8a6704f2e2d Mon Sep 17 00:00:00 2001 From: Leon van Kammen Date: Tue, 8 Aug 2023 15:14:23 +0200 Subject: [PATCH] update documentation --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e42c7cd..27fe12a 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,30 @@ [![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions) + + # Documentation / Website https://xrfragment.org -# available implementations +# Getting started + +Here are various ways to enhance your 3D assets/scenes with XR Fragments: + +| | ''difficulty'' | ''how'' | ''notes'' | +| 1 | easiest | the xrfragment.org Sandbox | open 3D file (fbx/gltf) in Blender, add custom properties, and load exported files into the sandbox | +| 2 | easy | hosted sandbox by forking xrfragment-helloworld | Basically #1 but it will be hosted for free at your own github URL | +| 3 | developer | fork xfragment-aframe-helloworld | requires javascript- and aframe.io developer-knowledge | +| 4 | developer | fork xfragment-three-helloworld | requires javascript- and threejs developer-knowledge | +| 5 | developer++ | use a parser-library below | lowlevel approach, more suitable for other scenarios | + + +# available parser-implementations -* [haXe](src/xrfragment) * [javascript](dist/xrfragment.js) [(+example)](test/test.js) * [python](dist/xrfragment.py) [(+example)](test/test.py) * [lua](dist/xrfragment.lua) [(+example)](test/test.lua) +* [haXe](src/xrfragment) (allows exporting to various programming languages) See documentation for more info