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

Add TOC to the README and other improvements (#2424) 

* Add TOC

* Added some extra things to the build instructions

* Added a link to the build doc
This commit is contained in:
Derek "Turtle" Roe 2024-06-05 23:51:17 -05:00 committed by GitHub
parent 0761ad4a83
commit f1d0c49d73
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Docs/BUILDING.md
View File

@ -7,9 +7,10 @@ If you just want to run Project64 or its development builds, use the [Readme](ht
## Required software ## Required software
* Git * [Git](https://git-scm.com/downloads)
* This is a hard requirement. It is used for the build step and requires the solution be a part of the Project64 git repository on disk. * This is a hard requirement. It is used for the build step and requires the solution be a part of the Project64 git repository on disk.
* Visual Studio 2015, 2017, or 2019 Community Edition * [Visual Studio 2015, 2017, or 2019 Community Edition](https://learn.microsoft.com/en-us/visualstudio/releases/2019/release-notes)
* Click on the Visual Studio year you want to use from the left dropdown, and follow the download process.
* During installation, select the `Programming Languages/Visual C++` option in the Visual Studio 2015 installer, or * During installation, select the `Programming Languages/Visual C++` option in the Visual Studio 2015 installer, or
* During installation, select the `Desktop development with C++` workload in Visual Studio 2017 and 2019 or newer * During installation, select the `Desktop development with C++` workload in Visual Studio 2017 and 2019 or newer

14
README.md
View File

@ -6,6 +6,18 @@
Project64 is a free and open-source emulator for the Nintendo 64 and Nintendo 64 Disk Drive written in C++ currently only for Windows (planned support for other platforms in the future). Project64 is a free and open-source emulator for the Nintendo 64 and Nintendo 64 Disk Drive written in C++ currently only for Windows (planned support for other platforms in the future).
* [Features](#features)
* [Screenshot](#screenshot)
* [Installation](#installation)
* [Supported requirements](#supported-requirements)
* [Support](#support)
* [Changelog](#changelog)
* [Dependencies](#dependencies)
* [Contributing](#contributing)
* [Maintainers and contributors](#maintainers-and-contributors)
* [🔗 Links](#---links)
* [License](#license)
## Features ## Features
- Development and debugging tools - Development and debugging tools
@ -73,6 +85,8 @@ If you would like to see a changelog that is available [here](./Docs/CHANGELOG.m
Contributions are always welcome! Contributions are always welcome!
If you want to contribute to this project, please click [here](https://github.com/project64/project64/blob/develop/Docs/BUILDING.md) to get more information on how to set up a local build environment.
See the [contributing](./.github/CONTRIBUTING.md) file for ways to get started. See the [contributing](./.github/CONTRIBUTING.md) file for ways to get started.
## Maintainers and contributors ## Maintainers and contributors