Xargon/Duckstation
1
0
Fork 0
mirror of https://github.com/RetroDECK/Duckstation.git synced 2025-02-16 19:05:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Connor McLaughlin 2020-01-11 16:59:18 +10:00 committed by GitHub
parent b255dfb439
commit 7bdcd00852
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -18,26 +18,27 @@
- SDL-compatible game controller (e.g. XB360/XBOne) - SDL-compatible game controller (e.g. XB360/XBOne)
## Building ## Building
Clone the respository with submodules (`git clone --recursive` or `git clone` and `git submodule update --init`).
### Windows ### Windows
Requirements: Requirements:
- Visual Studio 2019 - Visual Studio 2019
1. Open the Visual Studio solution `duckstation.sln` in the root, or "Open Folder" for cmake build. 1. Clone the respository with submodules (`git clone --recursive` or `git clone` and `git submodule update --init`).
2. Build, binaries are located in `bin/x64`. 2. Open the Visual Studio solution `duckstation.sln` in the root, or "Open Folder" for cmake build.
3. Copy the DLL files from `dep/msvc/bin64` to the binary directory. 3. Build, binaries are located in `bin/x64`.
4. Run `duckstation-x64-Release.exe` or whichever config you used. 4. Copy the DLL files from `dep/msvc/bin64` to the binary directory.
5. Run `duckstation-x64-Release.exe` or whichever config you used.
### Linux ### Linux
Requirements: Requirements:
- CMake - CMake
- SDL2 - SDL2
1. Create a build directory, either in-tree or elsewhere. 1. Clone the repository. Submodules aren't necessary, there is only one and it is only used for Windows.
2. Run cmake to configure the build system. Assuming a build subdirectory of `build-release`, `cd build-release && cmake -DCMAKE_BUILD_TYPE=Release -GNinja ..`. 2. Create a build directory, either in-tree or elsewhere.
3. Compile the source code. For the example above, run `ninja`. 3. Run cmake to configure the build system. Assuming a build subdirectory of `build-release`, `cd build-release && cmake -DCMAKE_BUILD_TYPE=Release -GNinja ..`.
4. Run the binary, located in the build directory under `src/duckstation/duckstation`. 4. Compile the source code. For the example above, run `ninja`.
5. Run the binary, located in the build directory under `src/duckstation/duckstation`.
### Android ### Android
**NOTE:** The Android frontend is still incomplete, not all functionality works and some paths are hard-coded. **NOTE:** The Android frontend is still incomplete, not all functionality works and some paths are hard-coded.
@ -45,9 +46,10 @@ Requirements:
Requirements: Requirements:
- Android Studio with the NDK and CMake installed - Android Studio with the NDK and CMake installed
1. Open the project in the `android` directory. 1. Clone the repository. Submodules aren't necessary, there is only one and it is only used for Windows.
2. Select Build -> Build Bundle(s) / APKs(s) -> Build APK(s). 2. Open the project in the `android` directory.
3. Install APK on device, or use Run menu for attached device. 3. Select Build -> Build Bundle(s) / APKs(s) -> Build APK(s).
4. Install APK on device, or use Run menu for attached device.
## Running ## Running
1. Configure the BIOS path in the settings. 1. Configure the BIOS path in the settings.