From e1f587a6292688cebab1a3fff0bb4b3b7267ece5 Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Tue, 25 Aug 2020 02:12:22 -0500 Subject: [PATCH 1/3] readme: update to focus only on push events than include pull requests --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c8a9a738b..dea90c54e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Cxbx-Reloaded - Original Xbox Emulator [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://img.shields.io/badge/License-GPL%20v2-blue.svg) -[![GitHub Actions](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/workflows/GitHub%20CI/badge.svg)](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/actions?query=workflow%3A%22GitHub+CI%22) +[![GitHub Actions](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/workflows/GitHub%20CI/badge.svg?event=push)](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/actions?query=event%3Apush+workflow%3A%22GitHub+CI%22) [![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?logo=discord)](https://discord.gg/26Xjx23) Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro) games on Microsoft Windows and Wine. From a501e9a4a40d57fd32383c5f6e4bb85879bbd82a Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Wed, 26 Aug 2020 17:37:04 -0500 Subject: [PATCH 2/3] readme: update bug report section --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dea90c54e..3651d0676 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,14 @@ Game or software specific issues can be reported in the [compatibility list](htt For emulation issues that are not specific to any single piece of software, a bug report can be submitted at [the Cxbx-Reloaded issue tracker](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/issues). -Make sure bug reports contain: +Make sure to follow the issue template and that it contains: * The build tested with, error message displayed (if any) - * Screenshots - * Xbe dump (created via `Edit > Dump Xbe Info To > File`) - * Kernel Debug log (created when running a game with `View > Debug Output (Kernel) > File` selected). + * **(You can copy and paste any popup messages. However, please keep it clean by paste and trimming down to only the message itself.)** + * Screenshots + * (optional unless has any graphic bug for references) + +**NOTICE: Failure to follow template will auto close your ticket.** + ## Additional information Cxbx-Reloaded has a [wiki](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/wiki) containing various subjects and background information. From 2720c5b4300f900c0cfee4a341a5d5946f7cbcf5 Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Thu, 27 Aug 2020 16:31:12 -0500 Subject: [PATCH 3/3] readme: fix grammars --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3651d0676..f4d8483a2 100644 --- a/README.md +++ b/README.md @@ -53,14 +53,14 @@ We welcome contributions, large and small. If you want to do some coding, be sure to read the [Developer notes](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/wiki/Developer-notes). -**IMPORTANT: Pull-Requests containing code derived from XQEMU will _not_ be approved until an agreement is reached to make work mutually beneficial. this includes updates to existing XQEMU derived code. We should not/will not become a hostile fork.** +**IMPORTANT: Pull-Requests containing code derived from XQEMU will _not_ be approved until an agreement is reached to make work mutually beneficial. This includes updates to existing XQEMU derived code. We should not/will not become a hostile fork.** Please contact us before you start working on something, so we can make sure your work is going to be accepted once finished. ### Main Prerequisites 1. [Git for Windows](https://git-scm.com) 2. [CMake](https://cmake.org) - * Some IDEs already have CMake support, so this is optional. + * Some IDEs already have CMake support, this is optional. ### Fetching the code 1. Run the following command in the command line: