Skip to content

Commit

Permalink
Document how to build a fork
Browse files Browse the repository at this point in the history
  • Loading branch information
roblabla authored and github-actions[bot] committed Nov 1, 2024
1 parent e48dc87 commit d7b5ade
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,19 @@ The actual CI is split in two jobs:
This will create a cross-platform dist, which is then uploaded to the releases.
Finally, the `generate_changelog.js` script is run to generate the changelog.

## Building a fork

If you want to use this CI to build your fork of ghidra, it's now very simple:

- First, fork this repository
- Navigate to the settings of the ghidra-ci fork, then go to Secrets and
Variables -> Actions -> Variables -> New Repository Variable.
- Here, create a variable named GHIDRA_REPO, and set its value to the `username/reponame`
of your ghidra fork, for instance `NationalSecurityAgency/Ghidra`.
- Save that variable.
- Enable github actions by navigating to the actions of your ghidra-ci fork,
and enabling all three workflows.

## Remaining work

There are several improvements to be made:
Expand Down

0 comments on commit d7b5ade

Please sign in to comment.