From 0829ecf11e3aab4e8ae49a97f8486f9ec1f412ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Yusuf=20Hano=C4=9Flu?=
<56837349+yusufhanoglu@users.noreply.github.com>
Date: Sat, 9 Apr 2022 19:14:42 +0300
Subject: [PATCH] Create README.md
---
README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 90 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4acaae4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,90 @@
+# IsolatedOS
+Alien Isolation inspired fan made 32 bit real operating system.
+# Installation
+Download ISO file in releases page and use an emulator to run it.
+Operating system can be run in legacy bios mode on any computer in theory but **I strongly suggest you to run it on virtual device**.
+# How to build
+## Required Packages
+Install the required packages to compile operating system.
+```
+gcc
+nasm
+qemu-kvm
+```
+Note: qemu-kvm package is required for testing iso
+## Build Scripts
+Open a terminal in project root directory and run script files.
+```
+chmod +x build.sh
+chmod +x run.sh
+./build.sh
+./run.sh
+```
+To build and run
+```
+./build.sh && ./run.sh
+```
+# How to change messages in OS
+To change messages in OS open vgasrc.cpp file in winsis directory and change following lines.
+```
+// PERSONAL:
+#define _PersonalCount 2
+const char* personal_title = "CONFIGURING MESSAGES";
+const char* personal[_PersonalCount] = {
+ "ALL MESSAGES CAN BE EDITTED ON TOP OF THE VGASRC CPP SOURCE",
+ "FILE"
+};
+
+// UTILITIES
+#define _UtilitiesCount 1
+const char* utilities_title = "COMPILATION OF SOURCE";
+const char* utilities[_UtilitiesCount] = {
+ "LOOK AT BUILD SHELL FILE"
+};
+
+// ABOUT
+#define _AboutCount 5
+const char* about_title = "ABOUT ISOLATED OS";
+const char* about[_AboutCount] = {
+ "ISOLATED OS VERSION A",
+ "THIS OPERATING SYSTEM IS DEVELOPED FOR ENTERTAINMENT PURPOSES",
+ "INSPIRED BY FAMOUS VIDEO GAME AND NOT RELATED WITH ANY TRADEMARK",
+ "OF IT",
+ "PROJECT LICENSED UNDER GPL VERSION TWO"
+};
+```
+If you change the line count you should change '_PersonalCount, _UtilitiesCount or _AboutCount' as well.
+# Login Password
+Default login password is 'ADMIN'.
+You can change password in vgasrc.cpp file.
+```
+const char* passwd = "ADMIN";
+
+```
+
+# Gallery
+
+
+
+
+
+
+# License
+```
+Copyright (C) 2021 Yusuf K. Hanoğlu
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; version 2
+of the License.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+```
+
+# Disclaimer
+This project is developed for **entertainment only** and is **not related** with aforementioned game or any of it's trademark.