README.md
1Microsoft Windows
2=================
3
4Fully supported. Build instructions will follow.
5
6Linux
7=====
8
9Clone the repository:
10
11```
12git clone https://github.com/vusec/ridl
13cd ridl
14```
15
16Install the submodules (dependencies):
17
18```
19git submodule init
20git submodule update
21```
22
23Generate the Makefile using CMake:
24
25```
26mkdir build
27cd build
28cmake ..
29```
30
31Build it using `make`:
32
33```
34make
35```
36
37If everything went well, you should now have `mdstool` and `mdstool-cli`.
38
39Mac OS X
40========
41
42Clone the repository:
43
44```
45git clone https://github.com/vusec/ridl
46cd ridl
47```
48
49Install the submodules (dependencies):
50
51```
52git submodule init
53git submodule update
54```
55
56Generate the Makefile using CMake:
57
58```
59mkdir build
60cd build
61cmake ..
62```
63
64Build it using `make`:
65
66```
67make
68```
69
70If everything went well, you should now have `mdstool-cli`.
71
72FreeBSD
73=======
74
75TODO
76
77FAQ
78===
79
80Q) Can I run this in a VM?
81
82This program relies on the `cpuid` instruction, which may report the wrong information in a VM. Make sure to run this on the actual hardware without virtualization.
83