RepoMirrors
/
osu
mirror of https://github.com/ppy/osu
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Getting Started section to Readme and MonoDevelop IDE for Linux

This commit is contained in:
Techno-coder 2017-12-30 21:38:33 +13:00 committed by GitHub
parent d8e6ff79f7
commit 03e9b05c3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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.