Difference between revisions of "Getting started"

From MKMCXX
Jump to: navigation, search
(Created page with "== Getting started == === Obtain the software === To get started using MKMCXX, you need to [http://www.mkmcxx.nl/#download download the software package] and unpack it on you...")
 
Line 2: Line 2:
  
 
=== Obtain the software ===
 
=== Obtain the software ===
To get started using MKMCXX, you need to [http://www.mkmcxx.nl/#download download the software package] and unpack it on your machine. In addition to the software, you also need to obtain a text editor. On Unix systems, typically vim or nano is installed. For Windows, we recommend using [https://notepad-plus-plus.org/ Notepad++].
+
To get started using MKMCXX, you need to [http://www.mkmcxx.nl/#download download the software package] and unpack it on your machine. The package contains a single executable file. For windows, this file is called "mkmcxx.exe", for Unix this is simply "mkmcxx".
 +
 
 +
In addition to the software, you also need to obtain a text editor. On Unix systems, typically vim or nano is installed. For Windows, we recommend using [https://notepad-plus-plus.org/ Notepad++].
 +
 
 +
=== Running the program ===
 +
Performing a simulation works somewhat different on Windows as compared to Unix. Please read the respective instructions below.
 +
 
 +
==== Windows ====
 +
 
 +
==== Unix ====
 +
Open a terminal and go to the folder wherein you have placed your mkmcxx executable.
 +
 
 +
<pre>
 +
cd example
 +
../mkmcxx -i input.mkm
 +
</pre>
 +
 
 +
==== Viewing the results ====

Revision as of 17:04, 10 July 2017

Getting started

Obtain the software

To get started using MKMCXX, you need to download the software package and unpack it on your machine. The package contains a single executable file. For windows, this file is called "mkmcxx.exe", for Unix this is simply "mkmcxx".

In addition to the software, you also need to obtain a text editor. On Unix systems, typically vim or nano is installed. For Windows, we recommend using Notepad++.

Running the program

Performing a simulation works somewhat different on Windows as compared to Unix. Please read the respective instructions below.

Windows

Unix

Open a terminal and go to the folder wherein you have placed your mkmcxx executable.

cd example
../mkmcxx -i input.mkm

Viewing the results