diff --git a/.github/sonar-project.properties b/.github/sonar-project.properties new file mode 100644 index 000000000..27015f1f7 --- /dev/null +++ b/.github/sonar-project.properties @@ -0,0 +1 @@ +sonar.projectKey=Project64-Esep diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..1ecaebcd8 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,27 @@ +name: Build + +on: + push: + branches: + - main + + +jobs: + build: + name: Build + runs-on: ubuntu-latest + permissions: read-all + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis + - uses: sonarsource/sonarqube-scan-action@master + env: + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} + SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }} + # If you wish to fail your job when the Quality Gate is red, uncomment the + # following lines. This would typically be used to fail a deployment. + # - uses: sonarsource/sonarqube-quality-gate-action@master + # timeout-minutes: 5 + # env: + # SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} \ No newline at end of file diff --git a/Docs/BUILDING.md b/Docs/BUILDING.md index abc23c545..5e7087ce4 100644 --- a/Docs/BUILDING.md +++ b/Docs/BUILDING.md @@ -7,9 +7,10 @@ If you just want to run Project64 or its development builds, use the [Readme](ht ## 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. -* 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 `Desktop development with C++` workload in Visual Studio 2017 and 2019 or newer diff --git a/README.md b/README.md index bf2856e8b..4cda2ca7e 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ Installer for the latest stable releases are available [here](https://www.pj64-e Download nightly builds [here](https://www.pj64-emu.com/nightly-builds). +If you want to contribute to this project, please click [here](https://github.com/project64/project64/blob/develop/Docs/BUILDING.md) to get more infromation on how to set up a local build environment. + AppVeyor (Windows x86/x64): [![Build status](https://ci.appveyor.com/api/projects/status/sbtwyhaexslyhgx3?svg=true )](https://ci.appveyor.com/project/project64/project64/branch/develop)