Difference between revisions of "Documentations"

From Yabause
Jump to: navigation, search
m
m
Line 11: Line 11:
 
* [[Readme DC | Dreamcast]]
 
* [[Readme DC | Dreamcast]]
  
==Other Documentation==
+
==Getting Help==
  
* [[Authors]]
+
* [http://webchat.freenode.net/?channels=yabause IRC] (freenode.net #yabause)
* [[Changelog]]
+
* [http://forums.yabause.org/ Forums]
* [[Roadmap#Goals|Goals]]
+
 
* [[Readme]]
+
== Contributing ==
 +
 
 +
=== Feature Requests and Bug Reports ===
 +
 
 +
Let us know about feature requests and bug reports on our [https://github.com/Yabause/yabause/issues issue tracker] The more information you can provide about your settings and setup the easier it will be to solve your issue.
 +
 
 +
=== Pull Requests ===
 +
 
 +
We accept pull requests through [https://github.com/Yabause/yabause/pulls GitHub]. See our [[Roadmap#Goals|development roadmap]] for potential ideas or take a look at the [https://github.com/Yabause/yabause/issues open issues].
 +
 
 +
=== Writing Documentation ===
 +
 
 +
Most of our documentation is contained on this wiki. Updating port usage and compiling instructions or the [[Compatibility list | compatibility list]] are great ways to help.
 +
 
 +
=== Issue Triage ===
 +
 
 +
Confirming and following up on bugs on the [https://github.com/Yabause/yabause/issues issue tracker] is another great way to help. This includes checking if older bugs are still valid or not. The [https://github.com/Yabause/yabause/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc least recently updated sort] makes it easy to see the bugs most in need of checking.

Revision as of 21:29, 2 July 2016

Yabause is a cross-platform Sega Saturn emulator licensed under GPLv2+.

Compiling and Usage

Instructions on how to compile and use Yabause depends on the platform. Qt, Android, GTK, OS X Cocoa and Dreamcast ports are available. The Qt port is the most advanced desktop version and is recommended over the GTK and OS X ports. Visit the following pages for platform-specific information.

Getting Help

Contributing

Feature Requests and Bug Reports

Let us know about feature requests and bug reports on our issue tracker The more information you can provide about your settings and setup the easier it will be to solve your issue.

Pull Requests

We accept pull requests through GitHub. See our development roadmap for potential ideas or take a look at the open issues.

Writing Documentation

Most of our documentation is contained on this wiki. Updating port usage and compiling instructions or the compatibility list are great ways to help.

Issue Triage

Confirming and following up on bugs on the issue tracker is another great way to help. This includes checking if older bugs are still valid or not. The least recently updated sort makes it easy to see the bugs most in need of checking.