diff --git a/docs/BUILD.md b/docs/BUILD.md index 3a5a6b0..81be5c3 100644 --- a/docs/BUILD.md +++ b/docs/BUILD.md @@ -2,6 +2,14 @@ ## Build Dependencies +**SHORTCUT:** All the build artifacts can be produced by the description in the `.yaml` files in `.github/workflows`. +These can be run on Github's infrastructure, or on a local PC using https://github.com/nektos/act. +Windows targets will require a Windows PC! +Doing things this way deals with all the dependency issues that Windows doesn't really give you a good way to deal with automatically. +It also guarantees that the same base container and environment gets used for every build no matter what machine it runs on. +I highly recommend you use either Github CI or `nektos/act` for dev builds of this software, as it **automates literally every one of the steps**. +CI-based builds follow the `WSL` version of the instructions. + You will need `ant` and java `java` and for building the jar. You will need `jpackage` for many of the potential build targets. I've been using Java 18 on Debian mostly, on Debian and Ubuntu, install the dependencies with: diff --git a/docs/WINDOWS.md b/docs/WINDOWS.md index fd02124..93ab018 100644 --- a/docs/WINDOWS.md +++ b/docs/WINDOWS.md @@ -7,7 +7,7 @@ an unbundled I2P router with an external JVM. #### Windows Jpackage: `.zip` -**(Not Recommended! This functionality is already included in the Easy-Install Bundle for Windows)** +**(Recommended for advanced users ONLY. Most people should be using Easy-Install Bundle for Windows)** 1. Start your I2P Router 2. Download the latest release `.zip` from [Github](https://github.com/eyedeekay/i2p.plugins.firefox/releases) and verify it's hash.