UnrealEngine/Plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document for dependencies

Browse Source
This commit is contained in:
Mamadou Babaei
2024-07-30 10:42:50 +02:00
parent 2ec782abb8
commit 60e71b8f78
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Handbook/README.md
+11 -5
View File
@@ -2,18 +2,24 @@
## Prerequisites ## Prerequisites
- Brave Browser (for PDF generation; in case you have Brave installed in a non-conventional path, or you'd like to use a different Chromium-based browser you need to adjust the path inside the GNUmakefile) - Brave Browser (for PDF generation; in case you have Brave installed in a non-conventional path, or you'd like to use a different Chromium-based browser you need to adjust the path inside the GNUmakefile).
- GNU Make - cygpath (Windows only) provided by [Git for Windows](https://gitforwindows.org/).
- Git - GNU Make.
- The Rust Toolchain - Git.
- PowerShell (Windows only) or `zip` command (Linux only).
- Python3 along with venv and pip. For Windows, a version of [WinPython](https://winpython.github.io/) is already shipped with this repo, so it's not an external requirement.
- Rsync and OpenSSH ([cwRsync](https://itefix.net/cwrsync) provides these for Windows).
- The Rust Toolchain and the Cargo package manager.
- Other common Unix utilities such as `awk`, `cp`, `cut`, `date`, `find`, `grep`, `hostname`, `mkdir`, `mktemp`, `mv`, `scp`, `sed`, `ssh`, `sort`, `tr`, `uname` provided by most distors. On Windows these are mostly provided by [Git for Windows](https://gitforwindows.org/).
### Microsoft Windows Prerequisites Installation Notes ### Microsoft Windows Prerequisites Installation Notes
- Download and install [Git Bash for Windows](https://gitforwindows.org/). - Download and install [Git for Windows](https://gitforwindows.org/).
- Download and install [the Rust Toolchain](https://rustup.rs/). - Download and install [the Rust Toolchain](https://rustup.rs/).
- Download [a without-guile binary build of GNU Make for Windows from ezwinports](https://sourceforge.net/projects/ezwinports/files/), e.g. <code>make-4.4.1-without-guile-w32-bin.zip</code>. - Download [a without-guile binary build of GNU Make for Windows from ezwinports](https://sourceforge.net/projects/ezwinports/files/), e.g. <code>make-4.4.1-without-guile-w32-bin.zip</code>.
- <code>make-\*-without-guile-w32-bin.zip/*</code> contents should be extracted and copied to your <code>Git\\mingw64\\</code>, e.g. <code>C:\\Program Files\\Git\\mingw64\\</code>, merging the folders, WITHOUT overwriting/replacing any existing files. - <code>make-\*-without-guile-w32-bin.zip/*</code> contents should be extracted and copied to your <code>Git\\mingw64\\</code>, e.g. <code>C:\\Program Files\\Git\\mingw64\\</code>, merging the folders, WITHOUT overwriting/replacing any existing files.
- After Git Bash installation, the changes to environment variables require a reboot. In order for these changes to take effect reboot the system, then proceed to the build section. - After Git Bash installation, the changes to environment variables require a reboot. In order for these changes to take effect reboot the system, then proceed to the build section.
- Download and install [cwRsync](https://itefix.net/cwrsync) which is only required for the `deploy` make target. In case you won't intend to use that, this could be skipped.
## How to preview, build, and deploy? ## How to preview, build, and deploy?