diff --git a/README.md b/README.md new file mode 100644 index 0000000..97b8768 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# KVISC (Kaleid Virtual Instruction Set Computer) + +| ![MIT Logo](https://www.os-k.eu/MITLOGO.png) | This program is free software, released under the terms of the [MIT License](LICENSE) | +|----------------------------------------------|----------------------------------------------------------------------| + +### Virtual machine for a x86-64-like custom assembly language ... + +... just for the sake of it + +Will later include an assembly and possibly a basic DOS-like operating system in assembly + +Note that every file within OS/K is written using spaces for tabulation, with each +tabulation being 4 spaces long. + +#### Compile from sources + +To compile, simply use at the root of this project : +``` +make +``` + +To compile and test, simply use at the root of this project : +``` +make test +```