V-Gears/doc/INSTALL.md

V-Gears Installation Guide

Manual installation

Currently, there is no easy way to install V-Gears automatically. Until it's implemented, this is the easiest method.

1. Create a folder for V-Gears data, outside the project. In Linux-based systems, it's recommended to use ~/.v-gears/.

2. Copy all the contents of the output/ folder to the newly created directory. It should end up like this:

   ~/.v-gears/
   ├── data
   ├── field_models_and_animation_metadata.xml
   ├── plugins.cfg
   ├── plugins.cfg_win32
   ├── plugins_d.cfg
   ├── RenderSystem_GL.so.1.12.10
   ├── resources.cfg
   ├── resources.cfg_linux
   ├── resources_d.cfg
   ├── system.fontdef
   └── v-gears.cfg_linux
   

3. Whenever you want to launch V-Gears or the V-Gears data installer, it must be done from this directory.

Next steps

• Install data
• Run V-Gears