mirror of
https://github.com/EverythingWindows/ShiftOS-TheRevival-Old.git
synced 2025-01-22 09:52:15 +00:00
Expand the readme.MD
added Requirement, build from source, and update the license
This commit is contained in:
parent
e5be131bbc
commit
13049c94f6
1 changed files with 40 additions and 3 deletions
43
README.md
43
README.md
|
@ -1,6 +1,7 @@
|
|||
# _**ShiftOS: Shift it your way**_
|
||||
|
||||
Join the Development Hub Discord Server : https://discord.gg/5QXxWJRM6R
|
||||
# _**ShiftOS**_
|
||||
## Shift it your way
|
||||
#### Join the Development Hub Discord Server : https://discord.gg/5QXxWJRM6R
|
||||
---
|
||||
|
||||
## :question: **What is ShiftOS?**
|
||||
> ShiftOS is a game about evolving an experiemental operating system called "ShiftOS" from a completly black and white text based command line environment to a fully graphical operating system filled with advanced features and beautiful colours.
|
||||
|
@ -16,6 +17,39 @@ Join the Development Hub Discord Server : https://discord.gg/5QXxWJRM6R
|
|||
>
|
||||
> After that, many iterations of revival and rewrite has been made. But most of those are either discontinued or in low activity. In November 1st, a revival project of ShiftOS has been made mainly by Everything Windows, it is going to be rewritten and reworked in VB.NET and later on migrates into C# and multi-platform support as the time progresses.
|
||||
|
||||
## :floppy_disk: **Installing ShiftOS**
|
||||
> Minimal system requirement :
|
||||
>- Windows 7
|
||||
>- Microsoft .NET Framework 4.5 or higher
|
||||
>- 512MB RAM
|
||||
>- 64MB free space
|
||||
>
|
||||
> Recommended requirement (The list is a subject to change) :
|
||||
>- Windows 10 or newer
|
||||
>- Microsoft .NET Framework 4.5 or higher
|
||||
>- 1GB RAM or higher
|
||||
>- at least 1GB of free space
|
||||
>- Active internet connection (necessary for several features)
|
||||
>
|
||||
> To run ShiftOS, you need to download the latest release on the <a href="https://github.com/EverythingWindows/ShiftOS-TheRevival/releases/tag/0.2.5">Release</a>.
|
||||
> If you download earlier version or you may have run it. The said version will check the latest version and automatically notify and recommend you to upgrade to the latest version.
|
||||
> Once you have downloaded the latest version, you can run the executable `ShiftOS-TheRevival.vX.X.X.exe` and you can start playing ShiftOS.
|
||||
|
||||
## :hammer: **Building ShiftOS from source**
|
||||
### 1.Prequisites
|
||||
>- Windows 10 or newer
|
||||
>- 4GB RAM or higher
|
||||
>- at least 1GB of free space
|
||||
>- Visual Studio 2019 or newer
|
||||
> It hasn't been tested on Visual Studio 2017 or earlier, but presumably it works. Other IDE hasn't been tested out, so be careful if you want to build ShiftOS using different IDE
|
||||
>
|
||||
### 2.Clone the repository
|
||||
> `https://github.com/EverythingWindows/ShiftOS-TheRevival.git`
|
||||
> This will create a local copy of the repository
|
||||
>
|
||||
### 3.Compiling the project
|
||||
> To start edit the project and compile it, open `ShiftOS-TheRevival.sln` and it will open Visual Studio (or corresponding IDE). Once it has opened, you can compile by using the Play button with `Debug` and `x86` option
|
||||
|
||||
## :raising_hand: **Frequently Asked Questions (FAQ)**
|
||||
**Why is it written in VB.NET?**
|
||||
> At first, I will write the code in VB.NET in order to make progresses of rewrite on the original code by Philip. After all features necessary are reworked, I will slowly migrate the code into C# while still using WinForms. And after reimplementing many functions from ShiftOS-TheReturn, We as the team will move into C++ and moving from WinForms to possibly Mono, from the migration to Mono, multi-platform support will be in work.
|
||||
|
@ -29,3 +63,6 @@ Join the Development Hub Discord Server : https://discord.gg/5QXxWJRM6R
|
|||
|
||||
**Can I contribute to the project?**
|
||||
> Yes, you can. You can take part of the projecy by contributing the code, either in VB.NET, C#, or C++ phase. Your contribution and support means the world to us as the team
|
||||
|
||||
## :page_with_curl: License
|
||||
> ShiftOS-TheRevival is licensed under the GNU GPL v3 License.
|
||||
|
|
Loading…
Reference in a new issue