Merge pull request #2005 from vgturtle127/master

General project improvements and updates
This commit is contained in:
zilmar 2021-03-12 07:18:29 +10:30 committed by GitHub
commit 33011f3a57
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 1123 additions and 944 deletions

17
.editorconfig Normal file
View File

@ -0,0 +1,17 @@
root = true
[*]
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = true
[*.{vcxproj,filters,vcxitems}]
insert_final_newline = false
end_of_line = crlf
tab_width = 2
[*.sln]
insert_final_newline = false
end_of_line = crlf
indent_style = tab
tab_width = 4

131
.gitattributes vendored
View File

@ -1,16 +1,121 @@
* text=auto
# C/C++ source files
*.c text diff=c
*.cc text diff=cpp
*.cxx text diff=cpp
*.cpp text diff=cpp
*.c++ text diff=cpp
*.hpp text diff=cpp
*.h text diff=c
*.h++ text diff=cpp
*.hh text diff=cpp
# Java source files
*.java text diff=java
*.gradle text diff=java
*.gradle.kts text diff=java
# Web source files
*.css text diff=css
*.htm text diff=html
*.html text diff=html
*.js text
*.jsp text
*.jspf text
*.jspx text
*.properties text
*.xml text
# Inno setup files
*.isl text
*.iss text
# Visual Studio file exceptions
*.sln text eol=crlf
*.csproj text eol=crlf
*.vbproj text eol=crlf
*.vcxproj text eol=crlf
*.vcproj text eol=crlf
*.dbproj text eol=crlf
*.fsproj text eol=crlf
*.lsproj text eol=crlf
*.wixproj text eol=crlf
*.modelproj text eol=crlf
*.sqlproj text eol=crlf
*.wwaproj text eol=crlf
*.xproj text eol=crlf
*.props text eol=crlf
*.filters text eol=crlf
*.vcxitems text eol=crlf
# All files that are binary and should not be normalized
# Images
*.png binary
*.jpg binary
*.psd binary
*.gif binary
*.bmp binary
*.ico binary
*.cur binary
# Binary Java files
# Binary data
*.exe binary
*.dll binary
*.e32 binary
*.lib binary
*.class binary
*.ear binary
*.jar binary
*.war binary
*.jks binary
# Compiled object files
*.slo binary
*.lo binary
*.o binary
*.obj binary
# Precompiled headers
*.gch binary
*.pch binary
# Compiled dynamic libraries
*.so binary
*.dylib binary
# Compiled Static libraries
*.lai binary
*.la binary
*.a binary
*.lib binary
# Binary data and executables
*.exe binary
*.out binary
*.app binary
*.dll binary
*.e32 binary
# Archives
*.7z binary
*.gz binary
*.tar binary
*.tgz binary
*.zip binary
*.rar binary
*.cab binary
# Images
*.png binary
*.jpg binary
*.jpeg binary
*.psd binary
*.gif binary
*.bmp binary
*.ico binary
*.cur binary
*.svg binary
*.tif binary
*.tiff binary

9
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,9 @@
# Introduction
First of all, thank you for considering contributing to Project64! Project64 is an open-source project and contributions by the community help fix bugs, add new features, and improve the project.
Following these guidelines will help make sure that users and developers alike can work together to achieve the projects goals.
Project64 is an open-source project and we love to receive contributions from the community. There are many ways to contribute, from writing and improving the documentation, testing, submitting bug reports and feature requests, or writing code which can be incorporated into Project64 itself.
Please don't use the issue tracker for support questions. Please join the Discord so the community can help with your issue!

1
.github/FUNDING.yml vendored Normal file
View File

@ -0,0 +1 @@
custom: "https://pj64-emu.com/support-project64.html"

19
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,19 @@
## Expected behavior
## Actual behavior
## Steps to reproduce the problem
1.
1.
1.
1.
1.
## Specifications
- Windows version:
- Project64 version:
- Plugins used:

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Project64 Community Support
url: https://discord.gg/Cg3zquF
about: Please ask and answer questions on our Discord!

7
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,7 @@
Fixes #
## Proposed Changes
-
-
-

View File

@ -1,8 +1,6 @@
# Project64 - Nintendo 64 Emulator
Project64 is a free and open-source emulator for the Nintendo 64 and 64DD written in C++.
The emulator is easy to use and includes powerful features for developers, ROM hackers, and more.
Project64 is a free and open-source emulator for the Nintendo 64 and Nintendo 64 Disk Drive written in C++ currently for Windows (planned support for other platforms in the future)
## System Requirements
@ -17,21 +15,13 @@ The emulator is easy to use and includes powerful features for developers, ROM h
* OpenGL 1.1 capable (Project64 Video)
* OpenGL 3.3 capable (GLideN64)
## How to use
<sub>(Games not included - do **NOT** ask for ROMs.)</sub>
### Stable Builds
Installer for the latest stable release: https://www.pj64-emu.com/download/project64-latest
Follow the instructions in the setup window to complete the installation.
### Development Builds
Development Builds are based off the latest source at GitHub. This allows you to use the latest changes straight away, though these changes may not be fully tested and have issues.
Official buildbot: https://www.pj64-emu.com/nightly-builds
Download nightly builds here: https://www.pj64-emu.com/nightly-builds
AppVeyor (Windows x86/x64): [![Build status](https://ci.appveyor.com/api/projects/status/sbtwyhaexslyhgx3?svg=true
)](https://ci.appveyor.com/project/project64/project64/branch/master)
@ -40,9 +30,35 @@ AppVeyor (Windows x86/x64): [![Build status](https://ci.appveyor.com/api/project
## Support
[**Join the official Project64 Discord Server**](https://discord.gg/Cg3zquF) to report any bugs/issues and seek help from Project64 developers, contributors and the community.
[**Join the official Project64 Discord server**](https://discord.gg/Cg3zquF) to seek help from Project64 developers, contributors, and the community!
### Compiling
```
Visual Studio Community
```
Load .sln project file and compile
See the [BUILDING.md](https://github.com/project64/project64/blob/master/BUILDING.md) file for details.
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) before contributing.
## Versioning
We use semantic versioning for Project64. For the versions available, see the [tags on this repository](https://github.com/project64/project64/tags)
## Authors
* **Zilmar** - *Current maintainer* - [Zilmar](https://github.com/project64)
* **Jabo** - *Previous member* - Jabo
* **Smiff** - *Previous member* - Smiff
* **Gent** - *Previous member* - Gent
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
Project64 is licensed under the
[GNU General Public License v2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).
This project is licensed under the GPLv2 License - see the [LICENSE.md](https://github.com/project64/project64/blob/master/license.md) file for details