summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@simplelittledream.com>2021-11-01 12:02:03 -0400
committerJacob McDonnell <jacob@simplelittledream.com>2021-11-01 12:02:03 -0400
commit0ea43cbc5bbb2bbefe48bd32bb40d1d825208c82 (patch)
tree47bb4d9a3184cf53a699b60d26414149d8ca1cb3 /README.md
parentcb7e1688c61dc6861d06b56475f46d5c7ac75f91 (diff)
Updated the README, Removed the License, Changed ints to Ulongs in coin
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..654c8f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Project Mustang
+
+***
+
+## Overview:
+
+A UNIX-like operating system with the graphical environment of a 90s operating system, written in C for the Raspberry PI 4.
+
+## Planned Features:
+
+- Full desktop environment similar to windows 9x
+
+- Programmer based environment with tools to make programming, and gui programming, easier; like NeXTSTEP
+
+- UNIX-like userland tools
+
+- Networking
+
+- Support for multiple programming languages like C, C++, GOLANG, and mabye Java
+
+## Current Goals:
+- Write userland programs
+
+## Building
+
+To build the project run:
+
+```
+make
+```
+
+To Install the userland programs run:
+
+```
+sudo make install
+```
+
+This will install the userland programs to `/opt/ProjectMustang/`. \ No newline at end of file