Skip to content

Commit 6e862f6

Browse files
authored
Markdownify and add badges to READEME.md
1 parent 264177c commit 6e862f6

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
Project Topaz
2-
========
1+
# Project Topaz
32

3+
[![release build](https://img.shields.io/github/workflow/status/project-topaz/topaz/build/release?label=release)](https://github.com/project-topaz/topaz/actions?query=workflow%3Abuild+branch%3Arelease)
4+
[![canary build](https://img.shields.io/github/workflow/status/project-topaz/topaz/build/canary?label=canary)](https://github.com/project-topaz/topaz/actions?query=workflow%3Abuild+branch%3Acanary)
5+
[![GitHub contributors](https://img.shields.io/github/contributors/project-topaz/topaz.svg)](https://GitHub.com/project-topaz/topaz/graphs/contributors/)
6+
7+
### License Notice
48
**If you're switching to Project Topaz from Darkstar Project, portions of our project may be governed by the [GNU AGPLv3](http://project-topaz.com/blob/release/AGPL3) instead of the [GNU GPLv3](http://project-topaz.com/blob/release/GPL3). This may require your server source code to be made available to users.**
59

610
**Any such portions will be clearly marked as being governed by the AGPLv3 in all relevant source files. Any source code not so marked is instead governed by the GPLv3, and may be used or modified without offering source to connecting users, provided it is not combined with any AGPLv3 source code. See Section 13 of both the [GPLv3](http://project-topaz.com/blob/release/GPL3#L552) and [AGPLv3](http://project-topaz.com/blob/release/AGPL3#L540) for more information, and the [Project Topaz License](http://project-topaz.com/blob/release/LICENSE) for [additional permissions](http://project-topaz.com/blob/release/LICENSE#L182) which may exempt you from this requirement.**
711

8-
Welcome to Project Topaz, an emulation server for FFXI.
12+
## Welcome to Project Topaz, an emulation server for FFXI.
913
Visit our Discord to keep in touch with the latest developments.
1014

11-
**Wiki:**
15+
### Wiki
1216
http://wiki.project-topaz.com/
1317

14-
**Discord:**
18+
### Discord
1519
https://discord.gg/nbYJfA5
1620

17-
Bug Reports and Unimplemented Features
18-
========
21+
### Bug Reports and Unimplemented Features
1922
You can find the tracker here: http://project-topaz.com/issues
2023

2124
Make sure both your FFXI client and the Topaz server are fully updated (and servers have been rebuilt with the latest code), to check the commit log since your last known update to see if the bug has already been fixed, and to use GitHub's search to see if the bug already been reported, before submitting a new bug report.
@@ -24,8 +27,7 @@ Bug reports should include steps to reproduce the bug.
2427

2528
We do take issues detailing unimplemented features _if_ the feature is _retail behavior_, and the issue report adequetly covers everything about that feature which is missing.
2629

27-
Pull Requests
28-
========
30+
### Pull Requests
2931
**By submitting a Pull Request to Project Topaz, you agree to our [Limited Contributor License Agreement](http://project-topaz.com/blob/release/CONTRIBUTOR_AGREEMENT.md)**
3032

3133
Commits should contain a descriptive name for what you are modifying

0 commit comments

Comments
 (0)