Browse Source

Normalize repo readme format

pull/4226/head
Joehu 4 months ago
parent
commit
538509309b
1 changed files with 9 additions and 18 deletions
  1. 9
    18
      README.md

+ 9
- 18
README.md View File

@@ -1,26 +1,20 @@
1
-osu!web
2
-=======
1
+# osu!web
3 2
 
4 3
 [![Build Status](https://travis-ci.org/ppy/osu-web.svg?branch=master)](https://travis-ci.org/ppy/osu-web) [![StyleCI](https://styleci.io/repos/41410580/shield)](https://styleci.io/repos/41410580) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/osu-web/localized.svg)](https://crowdin.com/project/osu-web) [![dev chat](https://discordapp.com/api/guilds/188630481301012481/widget.png?style=shield)](https://discord.gg/ppy)
5 4
 
6
-The future face of osu!.
5
+The browser-facing portion of [osu!](https://osu.ppy.sh/home).
7 6
 
8
-Requirements
9
-------------
7
+## Requirements
10 8
 
11 9
 - A PHP 7.1+ environment
12 10
 - MySQL 5.7
13 11
 - Elasticsearch
14 12
 
15
-
16
-Getting Started
17
----------------
13
+## Getting Started
18 14
 
19 15
 See the [setup guide](SETUP.md) for a rundown on how to get a development environment up.
20 16
 
21
-
22
-Contributing
23
-------------
17
+## Contributing
24 18
 
25 19
 We welcome all contributions, but keep in mind that we already have the full site designed (mock-ups). If you wish to work on a new section, please open a ticket 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.
26 20
 
@@ -30,21 +24,18 @@ Note that while we already have certain standards in place, nothing is set in st
30 24
 
31 25
 Please see [CONTRIBUTING.md](CONTRIBUTING.md) for information about the code standards we expect from pull requests.
32 26
 
33
-Seeking Help
34
-------------
27
+## Seeking Help
35 28
 
36 29
 If you need help with anything, you have two options:
37 30
 
38
-#### Create an Issue
31
+### Create an Issue
39 32
 
40 33
 If you have something you want to discuss in detail, or have hit an issue which you believe others will also have in deployment or development of the system, [opening an issue](https://github.com/ppy/osu-web/issues) is the best way to get help. It creates a permanent resource for others wishing to contribute to conversation. Please **make sure to search first** in case someone else has already addressed the same issue!
41 34
 
42
-#### Discord
35
+### Discord
43 36
 
44 37
 Alternatively, you can join the [development discord](https://discord.gg/ppy) for assistance.
45 38
 
46
-
47
-Licence
48
--------
39
+## Licence
49 40
 
50 41
 osu!web is licensed under AGPL version 3 or later. Please see [the licence file](LICENCE) for more information. [tl;dr](https://tldrlegal.com/license/gnu-affero-general-public-license-v3-(agpl-3.0)) if you want to use any code, design or artwork from this project, attribute it and make your project open source under the same licence.

Loading…
Cancel
Save