idk/i2p.plugins.firefox
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

Add nektos/act note to BUILD.md

Browse Source
This commit is contained in:
eyedeekay
2024-03-18 10:35:20 -04:00
parent bbd2fdeeec
commit eb195f7dba
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/BUILD.md
View File

@ -2,6 +2,14 @@
## Build Dependencies ## 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 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 `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: on Debian mostly, on Debian and Ubuntu, install the dependencies with:

2
docs/WINDOWS.md
View File

@ -7,7 +7,7 @@ an unbundled I2P router with an external JVM.
#### Windows Jpackage: `.zip` #### 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 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. 2. Download the latest release `.zip` from [Github](https://github.com/eyedeekay/i2p.plugins.firefox/releases) and verify it's hash.