From 2d54be4cffddcceb4fd3311e1d6bb71a48ff4dc2 Mon Sep 17 00:00:00 2001 From: pfgithub Date: Thu, 23 Mar 2017 17:42:42 -0700 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2b22423..22725cc 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The official, open-source, C# revamp of ShiftOS. We are licensed under the MIT license. A simple description is: 1. Don't steal our code and call it yours -2. If you fork us, leave any copyright statements and license info at the top of all .cs files. You can use the InsertLicense executable to insert the statement into any code files missing the copyright statement. +2. Leave copyright statements and license info at the top of all .cs files. `InsertLicense.exe` can be used to add the license to any files missing it. ### Using our code for your own front-end project -- cgit v1.2.3 From 83dd55d028ed0d82cd7af7dd9ae2959f1ae2aae5 Mon Sep 17 00:00:00 2001 From: pfgithub Date: Thu, 23 Mar 2017 17:50:49 -0700 Subject: Update README.md with links and wording `front-end project` `and ShiftOS.Server` --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 22725cc..4e5e4a2 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,16 @@ The official, open-source, C# revamp of ShiftOS. ## License -We are licensed under the MIT license. A simple description is: +We are licensed under the [MIT license](https://github.com/shiftos-game/ShiftOS/blob/master/LICENSE). A simple description is: -1. Don't steal our code and call it yours -2. Leave copyright statements and license info at the top of all .cs files. `InsertLicense.exe` can be used to add the license to any files missing it. +1. Don't steal our code and claim ownership of it +2. Leave copyright statements and license info at the top of all .cs files. `InsertLicense.exe` can be used to add the license to all files without it. -### Using our code for your own front-end project +### Using our code for your own project -You may use the ShiftOS.Engine, ShiftOS.Objects, and ShiftOS.Server projects to create your own games. You must include the original license and link back to this in your game or credits. +You may use the ShiftOS.Engine, ShiftOS.Objects, and ShiftOS.Server projects to create your own games. You must include the original license and link back to [ShiftOS](https://github.com/shiftos-game/ShiftOS) in your `README` and in your game or credits. ## Contributing -See `CONTRIBUTING.md` +See [`CONTRIBUTING.md`](https://github.com/shiftos-game/ShiftOS/blob/master/CONTRIBUTING.md) -- cgit v1.2.3 From 22f56fa4fd0e89d96f892a9c2575ae6867daf687 Mon Sep 17 00:00:00 2001 From: Michael VanOverbeek Date: Tue, 18 Apr 2017 12:21:56 -0400 Subject: Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4e5e4a2..62e401a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,14 @@ We are licensed under the [MIT license](https://github.com/shiftos-game/ShiftOS/ You may use the ShiftOS.Engine, ShiftOS.Objects, and ShiftOS.Server projects to create your own games. You must include the original license and link back to [ShiftOS](https://github.com/shiftos-game/ShiftOS) in your `README` and in your game or credits. +## Compiling the code + +To compile the code, simply clone the repository, and open it in Visual Studio. Then, set `ShiftOS.WinForms` as your startup project by right-clicing it in **Solution Explorer**. Then, hit **F5** to compile and run the game. + +## Where the hell is the **Issues** tab? This can't be GitHub! + +No, you're wrong. We've actually disabled the Issues tab in place of our own in-place [bugtracker](http://getshiftos.ml/Bugs). Please post bugs there. It is easier for us to track and integrate with the rest of the community. + ## Contributing See [`CONTRIBUTING.md`](https://github.com/shiftos-game/ShiftOS/blob/master/CONTRIBUTING.md) -- cgit v1.2.3