From 03e9b05c3fba27c1e65a4880d3cb8c694d2f1cc3 Mon Sep 17 00:00:00 2001 From: Techno-coder Date: Sat, 30 Dec 2017 21:38:33 +1300 Subject: [PATCH 1/2] Add Getting Started section to Readme and MonoDevelop IDE for Linux --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 856536d22d..f9936e9259 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,13 @@ This is still heavily under development and is not intended for end-user use. Th # Requirements -- A desktop platform which can compile .NET 4.5 (tested on macOS, linux and windows). We recommend using [Visual Studio Code](https://code.visualstudio.com/) (all platforms) or [Visual Studio Community Edition](https://www.visualstudio.com/) (windows only), both of which are free. +- A desktop platform which can compile .NET 4.5 (tested on macOS, linux and windows). We recommend using [MonoDevelop](http://www.monodevelop.com/download/) (Linux), [Visual Studio Code](https://code.visualstudio.com/) (macOS) or [Visual Studio Community Edition](https://www.visualstudio.com/) (Windows), all of which are free. - Make sure you initialise and keep submodules up-to-date. +# Getting Started +- Clone the repository including submodules (`git clone --recurse-submodules https://github.com/ppy/osu`) +- Build in your IDE of choice (recommended IDEs automatically restore nuget packages; if you are using an alternative make sure to `nuget restore`) + # Contributing We welcome all contributions, but keep in mind that we already have a lot of the UI designed. If you wish to work on something with the intention on having it included in the official distribution, please open an issue for discussion and we will give you what you need from a design perspective to proceed. If you want to make *changes* to the design, we recommend you open an issue with your intentions before spending too much time, to ensure no effort is wasted. From e28f91a6028dd8b60231e9da40ecf99b29181b8c Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Sat, 30 Dec 2017 18:20:51 +0900 Subject: [PATCH 2/2] Improve wording and fix macOS requirement --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index f9936e9259..47df86f57e 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ This is still heavily under development and is not intended for end-user use. Th # Requirements -- A desktop platform which can compile .NET 4.5 (tested on macOS, linux and windows). We recommend using [MonoDevelop](http://www.monodevelop.com/download/) (Linux), [Visual Studio Code](https://code.visualstudio.com/) (macOS) or [Visual Studio Community Edition](https://www.visualstudio.com/) (Windows), all of which are free. -- Make sure you initialise and keep submodules up-to-date. +- A desktop platform that can compile .NET 4.6.1. We recommend using [Visual Studio Community Edition](https://www.visualstudio.com/) (Windows), [Visual Studio for Mac](https://www.visualstudio.com/vs/visual-studio-mac/) (macOS) or [MonoDevelop](http://www.monodevelop.com/download/) (Linux), all of which are free. [Visual Studio Code](https://code.visualstudio.com/) may also be used but requires further setup steps which are not covered here. # Getting Started - Clone the repository including submodules (`git clone --recurse-submodules https://github.com/ppy/osu`)