..	*******************************************************************************
	* MetaFactory.io R2
	* Technical Documentation
	* 
	* File name   : GetAndInstall.rst
	* Created by  : Original text: MetaFactorry (Marnix Bochove)
	* Last update : 09-03-2021
	* Updated by  : Niels de Nies
	*
	* MetaFactory BV Amsterdam 
	*******************************************************************************

.. include:: /external-links.txt
.. include:: /inline-images.txt


Get and install MetaFactory environment
=======================================

#.	Request an evaluation copy of MetaFactory by sending an email to info@metafactory.nl.
	No installation is required. 

#.	Unzip the received package to a location of your choice and run the run64.bat file inside the main folder if you use it on 64-bit windows.

	If you are an OS X user, doubleclick the .dmg file and drag MetaFactory to your applications folder.
	
	|Glasses M| Read more about the installation for :ref:`MetaFactory on Windows <HowTo/GetAndInstall:MetaFactory on Windows>` 
	or :ref:`MetaFactory on OSX/MacOS <HowTo/GetAndInstall:MetaFactory on OSX/MacOS>`
	
	If you are using an IDE to edit the files we recommend configuring it for use with MetaFactory 
	in order to validate the XML and enable auto-completion. You can check out the required steps at :ref:`Configuring your IDE <HowTo/Configure-IDE:Configuring your IDE>`. 
	
	If you are using IntelliJ you can also control MetaFactory from inside the IDE using the IntelliJ plugin.
	
	|Glasses M| Learn more on how to configure this at :ref:`Installing IntelliJ Plugin <HowTo/Configure-IntelliJ-Plugin:Installing and configuring IntelliJ IDEA plugin>`

#.	Create a new project (File –> New. - |Loupe S| Example: :ref:`Hello World <Tutorials/T01_HelloWorld:T01 Hello World>`)

	You will be asked where to save the **xml** file.
	
#.	Choose a location inside your preferred projects location.
	
	A default folder structure, including basic versions of **model.xml** and **pattern.xml** is also created.
	MetaFactory requires these files with at least this basic content to run, hence it creates them.

#.	|Glasses M| Learn more about the Project-structure_ and read about the functionality of metafactory.xml, model.xml and pattern.xml at 
	:ref:`Components and Structure <Background/ProjectStructure:MetaFactory Project Structure>`.
	
MetaFactory on Windows
----------------------

#.	Unzip the received file at a location of your choice
#.	Launch MetaFactory by running run64.cmd (64 bit) or run.cmd (32 bit)
#.	At first startup you will be asked to select a license. Choose the option “I have a valid license file” and then select the file that you have received:  ‘metafactory.key’.


MetaFactory on OSX/MacOS
------------------------


#.	Double click on the MetaFactory.dmg file that you’ve received.
#.	Drag MetaFactory.app to the Programs folder.

That’s it, you’ve now installed MetaFactory.

You can start the application either the ‘OSX way’ or by running the sh script from the MetaFactory.app folder:

#.	Open a terminal
#.	cd /Applications/MetaFactory.app/Contents/Resources/Java
#.	./run64.sh

Running the application this way provides additional debug information in the console, which can be useful to developers.