mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2024-12-23 16:51:53 +01:00
Documentation improvements (#6)
* Adds templates for PR's and issues. * Adds some basic documentation to get people up and running (although it will change very quickly).
This commit is contained in:
Robin Jones
GitHub
parent
c4aaf3055b
commit
7559850c49
90
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
90
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,90 @@
|
||||
name: Bug report
|
||||
description: Create a bug report to help us improve
|
||||
labels:
|
||||
- "Type: Bug"
|
||||
- "Status: Waiting triage"
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# :warning: **Please read before raising the issue** :warning:
|
||||
|
||||
If you have a **question**, need clarification on something, need help on a particular situation or want to start a discussion, **DO NOT** open an issue here. _It will be automatically closed!_
|
||||
First raise it in discussions.
|
||||
If you realy want to raise an issue, please make sure to follow the template and provide the required information.
|
||||
Failing to do so will most likely end up on the issue being close. Don't take offense at this.
|
||||
It is simply a time management decision.
|
||||
Whenever an issue is raised without following the template and the required information is not provided, very often too much time has to be spent going back and forth to obtain the details that are outlined below.
|
||||
|
||||
- type: input
|
||||
id: firmware_version
|
||||
attributes:
|
||||
label: Firmware version of the flashcart
|
||||
description: The firmware version used
|
||||
placeholder: V0.1
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: input
|
||||
id: menu_version
|
||||
attributes:
|
||||
label: Menu version used
|
||||
description: The menu version used
|
||||
placeholder: e.g 1.2.3.456, N/A
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear and concise description of what the problem is.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: repro_steps
|
||||
attributes:
|
||||
label: How to reproduce
|
||||
description: Detailed repro steps so we can see the same problem. If not already explained above.
|
||||
placeholder: |
|
||||
1.
|
||||
2.
|
||||
...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: expected_behaviour
|
||||
attributes:
|
||||
label: Expected behaviour
|
||||
description: A clear and concise description of what you expected to happen. If applicable.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots
|
||||
description: Very helpful if you send along a few screenshots to help visualize the issue!
|
||||
placeholder: drag and drop here, if applicable
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: other_things
|
||||
attributes:
|
||||
label: Aditional information
|
||||
description: Other suggested things. If applicable/relevant.
|
||||
placeholder: |
|
||||
for example link to the repository with sample code
|
||||
code snippets
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
### Make an effort to fix the bug
|
||||
|
||||
Attempt to submit a [Pull Request (PR)](https://help.github.com/articles/about-pull-requests/) that fixes the bug. Include in this PR a test that verifies the fix. If you were not able to fix the bug, a PR that illustrates your partial progress will suffice.
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/Polprzewodnikowy/N64FlashcartMenu/discussions
|
||||
about: Channel for asking QUESTIONS.
|
||||
53
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
53
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,53 @@
|
||||
name: Feature request
|
||||
description: Suggest an idea to help us improve.
|
||||
labels:
|
||||
- "Type: Feature request"
|
||||
- "Status: waiting feedback"
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# :warning: **Please read before raising the issue** :warning:
|
||||
|
||||
If you have a **question**, need clarification on something, need help on a particular situation or want to start a discussion, **DO NOT** open an issue here. _It will be automatically closed!_
|
||||
|
||||
If you realy want to raise an issue, please make sure to follow the template and provide the required information. Failing to do so will most likely end up on the issue being close. Don't take offense at this. It is simply a time management decision. Whenever an issue is raised without following the template and the required information is not provided, very often too much time has to be spent going back and forth to obtain the details that are outlined below.
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Is your feature request related to a problem? Please describe.
|
||||
placeholder: A clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: How to solve the problem
|
||||
description: Describe the solution you'd like
|
||||
placeholder: A clear and concise description of what you would like to happen/exist.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Describe alternatives you've considered
|
||||
description: What alternatives you've considered and/or tested.
|
||||
placeholder: A clear and concise description of any alternative solutions, features or tools that you've considered.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: other_context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
placeholder: |
|
||||
code snnipets
|
||||
screenshots
|
||||
mockups
|
||||
validations:
|
||||
required: false
|
||||
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
<!--- Describe your changes in detail -->
|
||||
|
||||
## Motivation and Context
|
||||
<!--- What does this sample do? What problem does it solve? -->
|
||||
<!--- If it fixes/closes/resolves an open issue, please link to the issue here -->
|
||||
|
||||
## How Has This Been Tested?
|
||||
<!-- (if applicable) -->
|
||||
<!--- Please describe in detail how you tested your sample/changes. -->
|
||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
||||
<!--- see how your change affects other areas of the code, etc. -->
|
||||
|
||||
## Screenshots
|
||||
<!-- (if appropriate): -->
|
||||
|
||||
## Types of changes
|
||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||
- [ ] Improvement (non-breaking change that adds a new feature)
|
||||
- [ ] Bug fix (fixes an issue)
|
||||
- [ ] Breaking change (breaking change)
|
||||
- [ ] Config and build (change in the configuration and build system, has no impact on code or features)
|
||||
|
||||
## Checklist:
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||
- [ ] My code follows the code style of this project.
|
||||
- [ ] My change requires a change to the documentation.
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
- [ ] I have added tests to cover my changes.
|
||||
- [ ] All new and existing tests passed.
|
||||
|
||||
<!--- It would be nice if you could sign off your contribution by replacing the name with your GitHub user name and GitHub email contact. -->
|
||||
Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL>
|
||||
42
README.md
42
README.md
@ -1,3 +1,43 @@
|
||||
# N64FlashcartMenu
|
||||
**This repo and its documentation is currently experimental and subject to change without notice.**
|
||||
|
||||
## Aims
|
||||
* Support as many flashcarts as possible
|
||||
* Be open source using preferably MIT licensed third party licenced libraries where possible.
|
||||
* Be testable, where possible using CTest, but if not, in an emulated environment.
|
||||
* Encourage active development from community members and flashcart owners.
|
||||
|
||||
## Basic usage
|
||||
|
||||
### SC64
|
||||
Download the `sc64menu.n64` ROM from the latest action run assets.
|
||||
Add it to the root folder on your SD card.
|
||||
|
||||
Add a folder called `n64` in the root of your SD card.
|
||||
Create a file called `config.txt` in the `n64` folder.
|
||||
|
||||
Add the following content, replacing the comments.
|
||||
```
|
||||
game_path=<!-- path to your ROM from the root of your SD card -->
|
||||
save_path=<!-- path to a save file from the root of your SD card -->
|
||||
save_type=<!-- a number representing the save type (see save types) -->
|
||||
```
|
||||
|
||||
#### Save types
|
||||
`0` = NONE
|
||||
`1` = EEPROM_4K
|
||||
`2` = EEPROM_16K
|
||||
`3` = SRAM
|
||||
`4` = SRAM_BANKED
|
||||
`5` = SRAM_128K
|
||||
`6` = FLASHRAM
|
||||
|
||||
|
||||
### ED64
|
||||
Not Currently not suppported, but there is an aim to do so.
|
||||
This will likely replace AltraOSv1
|
||||
|
||||
|
||||
# Developer documentation
|
||||
**Work in progress!**
|
||||
|
||||
Nothing to see here, come back later.
|
||||
|
||||
1
docs/README.md
Normal file
1
docs/README.md
Normal file
@ -0,0 +1 @@
|
||||
**Nothing to see here, check back later!**
|
||||
Loading…
Reference in New Issue
Block a user