h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-19 06:02:56 +08:00
Code Issues Releases Wiki Activity
73f2709a2d
osu-lazer/README.md
Dean Herbert b52781db73 Update README.md
2017-05-01 22:00:36 +09:00

2.9 KiB
Raw Blame History

osu! Build status CodeFactor dev chat

Rhythm is just a click away. The future of osu! and the beginning of an open era!

Status

This is still heavily under development and is not intended for end-user use. This repository is intended for developer collaboration. You're welcome to try and use it but please do not submit bug reports without a patch. Please do not ask for help building or using this software.

Requirements

  • A desktop platform which can compile .NET 4.5 (tested on macOS, linux and windows). We recommend using Visual Studio Code (all platforms) or Visual Studio Community Edition (windows only), both of which are free.
  • Make sure you initialise and keep submodules up-to-date.

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.

Contributions can be made via pull requests to this repository. We hope to credit and reward larger contributions via a bounty system. If you're unsure of what you can help with, check out the list of open issues.

Note that while we already have certain standards in place, nothing is set in stone. If you have an issue with the way code is structured; with any libraries we are using; with any processes involved with contributing, please bring it up. I welcome all feedback so we can make contributing to this project as pain-free as possible.

Licence

The osu! client code and framework are licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

Please note that this does not cover the usage of the "osu!" or "ppy" branding in any software, resources, advertising or promotion, as this is protected by trademark law.

Please also note that game resources are covered by a separate licence. Please see the ppy/osu-resources repository for clarifications.