ShuriZma
/
project64
mirror of https://github.com/project64/project64.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
project64/README.md

67 lines
2.5 KiB
Markdown
Raw Normal View History

[README.md] Reword and remove superfluous wording I liked some of the changes by @Alen-Alic but I think keeping it short and sweet is best Under the requisites including sound card and storage is redundant, since every computer that runs Windows XP comes with audio capabilities, and storage is not a concern since who doesn't have 5MB of storage available. After this commit, please do not add other modifications to the README.md unless there has been a significant development (like Android version coming back). For the meantime, we believe it is already good as-is.
2020-06-15 04:53:55 +00:00
# Project64 - Nintendo 64 Emulator
Update README.md More additions
2020-06-13 12:14:23 +00:00
Move changelog and build instructions to a doc dir (#2250) * Move changelog and build instructions to a doc dir * Update README with new dir and add a link to the changelog
2022-07-18 12:10:37 +00:00
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).
Update README.md
2020-06-14 20:21:07 +00:00
Updates README.md Updates to system requirements, also minor fixes.
2020-06-13 13:20:05 +00:00
## System Requirements
Update README.md Further grammar, wording and layout fixes.
2020-06-13 11:12:55 +00:00
[README.md] Reword and remove superfluous wording I liked some of the changes by @Alen-Alic but I think keeping it short and sweet is best Under the requisites including sound card and storage is redundant, since every computer that runs Windows XP comes with audio capabilities, and storage is not a concern since who doesn't have 5MB of storage available. After this commit, please do not add other modifications to the README.md unless there has been a significant development (like Android version coming back). For the meantime, we believe it is already good as-is.
2020-06-15 04:53:55 +00:00
* Operating System
Enforce a standard issue template (#2202) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list
2022-03-03 11:33:56 +00:00
* Windows XP and later
Update README.md Further grammar, wording and layout fixes.
2020-06-13 11:12:55 +00:00
* CPU
Enforce a standard issue template (#2202) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list
2022-03-03 11:33:56 +00:00
* Intel or AMD processor with at least SSE2 support
Update README.md Further grammar, wording and layout fixes.
2020-06-13 11:12:55 +00:00
* RAM
[README.md] Reword and remove superfluous wording I liked some of the changes by @Alen-Alic but I think keeping it short and sweet is best Under the requisites including sound card and storage is redundant, since every computer that runs Windows XP comes with audio capabilities, and storage is not a concern since who doesn't have 5MB of storage available. After this commit, please do not add other modifications to the README.md unless there has been a significant development (like Android version coming back). For the meantime, we believe it is already good as-is.
2020-06-15 04:53:55 +00:00
* 512MB or more
Update README.md (hyperlinking Discord in text)
2020-06-15 17:43:15 +00:00
* Graphics card
[README.md] Reword and remove superfluous wording I liked some of the changes by @Alen-Alic but I think keeping it short and sweet is best Under the requisites including sound card and storage is redundant, since every computer that runs Windows XP comes with audio capabilities, and storage is not a concern since who doesn't have 5MB of storage available. After this commit, please do not add other modifications to the README.md unless there has been a significant development (like Android version coming back). For the meantime, we believe it is already good as-is.
2020-06-15 04:53:55 +00:00
* DirectX 8 capable (Jabo's Direct3D8)
* OpenGL 1.1 capable (Project64 Video)
* OpenGL 3.3 capable (GLideN64)
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
Update README.md
2020-06-14 20:21:07 +00:00
### Stable Builds
Bad redirect update (#2198)
2022-02-19 02:50:43 +00:00
Installer for the latest stable release: https://www.pj64-emu.com/windows-downloads
Removed double link in readme
2019-08-05 00:57:54 +00:00
Created README.md
2019-07-15 18:25:31 +00:00
Follow the instructions in the setup window to complete the installation.
Move changelog and build instructions to a doc dir (#2250) * Move changelog and build instructions to a doc dir * Update README with new dir and add a link to the changelog
2022-07-18 12:10:37 +00:00
If you would like to see the changelog: [Changelog here](https://github.com/project64/project64/blob/develop/Docs/CHANGELOG.md)
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
Download nightly builds here: https://www.pj64-emu.com/nightly-builds
Update README.md Add development builds, change some wordings, fix grammar, and fix markup.
2019-11-20 09:42:12 +00:00
AppVeyor (Windows x86/x64): [![Build status](https://ci.appveyor.com/api/projects/status/sbtwyhaexslyhgx3?svg=true
Update readme for develop branch
2021-04-23 08:14:23 +00:00
)](https://ci.appveyor.com/project/project64/project64/branch/develop)
Update README.md Add development builds, change some wordings, fix grammar, and fix markup.
2019-11-20 09:42:12 +00:00
Update README.md
2020-06-14 20:21:07 +00:00
<sub>Note: x64 builds are **NOT** recommended for regular use. They are incomplete and very experimental. Due to this, x64 builds are currently _slower_ than 32-bit builds.</sub>
## Support
Enforce a standard issue template (#2202) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list
2022-03-03 11:33:56 +00:00
[**Join the official Project64 Discord server**](https://discord.gg/Cg3zquF) to seek help from Project64 developers, contributors, and the community! Please ask questions here first and see if you should open an issue.
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
### Compiling
```
Some repo improvements and small fixes (#2207) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list * Add a reminder in the CONTRIBUTING file * Add a small improvement to the README * Update BUG.yml with some formatting and text improvements * Switch to YAML for the feature request template as well * Remove old Markdown templates * Fix placeholder on line 30 * Fix assignees * Fix assignees part 2 * Fix assignees part 3 * Fix spacing * Finally fix formatting (YAML is picky) * Fix it part 11 thousand or something * Finally fixed maybe sort of kinda * Update BUG.yml * Fixed some weirdness * Fix required maybe * Finally fixed perhaps?
2022-03-09 06:41:57 +00:00
Visual Studio Community 2015 or later
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
```
Enforce a standard issue template (#2202) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list
2022-03-03 11:33:56 +00:00
Load .sln project file and compile.
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
Move changelog and build instructions to a doc dir (#2250) * Move changelog and build instructions to a doc dir * Update README with new dir and add a link to the changelog
2022-07-18 12:10:37 +00:00
See the [BUILDING.md](https://github.com/project64/project64/blob/develop/Docs/BUILDING.md) file for details.
Forgot to add a link to the build doc
2021-03-10 09:11:50 +00:00
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
## Contributing
Enforce a standard issue template (#2202) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list
2022-03-03 11:33:56 +00:00
Please read [CONTRIBUTING.md](https://github.com/project64/project64/blob/develop/.github/CONTRIBUTING.md) before contributing, opening issues or pull requests, or for other contributions.
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
## Versioning
Enforce a standard issue template (#2202) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list
2022-03-03 11:33:56 +00:00
We use semantic versioning for Project64. For the versions available, see the [tags on this repository](https://github.com/project64/project64/tags).
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
Update README.md Add some more of the relevant contributors to the list Also if anybody wants to be added/removed from the list, feel free to open an issue or get in contact with Zilmar or me. Also if you guys have any suggestions for additions, also get in touch.
2021-03-16 05:54:47 +00:00
## Author / Contributors
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
Oops
2021-03-11 01:02:06 +00:00
* **Zilmar** - *Current maintainer* - [Zilmar](https://github.com/project64)
Update README.md Add some more of the relevant contributors to the list Also if anybody wants to be added/removed from the list, feel free to open an issue or get in contact with Zilmar or me. Also if you guys have any suggestions for additions, also get in touch.
2021-03-16 05:54:47 +00:00
* **Jabo** - *Previous contributor* - Jabo
* **Smiff** - *Previous contributor* - Smiff
* **Gent** - *Previous contributor* - Gent
Switch to markdown for changelog and update readme a bit
2021-03-10 08:51:58 +00:00
Update README.md Fix link to contributors
2021-04-02 08:19:59 +00:00
See also the list of [contributors](https://github.com/project64/project64/contributors) who participated in this project.
Created README.md
2019-07-15 18:25:31 +00:00
Updates README.md Updates to system requirements, also minor fixes.
2020-06-13 13:20:05 +00:00
## License
Update README.md Further grammar, wording and layout fixes.
2020-06-13 11:12:55 +00:00
Enforce a standard issue template (#2202) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list
2022-03-03 11:33:56 +00:00
This project is licensed under the GPLv2 License - see the [LICENSE.md](https://github.com/project64/project64/blob/develop/license.md) file for details.