Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Setup Instructions to README.md #23

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Setup Instructions to README.md #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,10 @@ Each branch of this project represents an example:
- [`submodules` shows how paperweight can be applied on a fork using the more traditional git submodule system](https://github.com/PaperMC/paperweight-examples/tree/submodules)
- [`mojangapi` shows how a fork could patch arbitrary non-git directories (such as `Paper-MojangAPI`)](https://github.com/PaperMC/paperweight-examples/tree/mojangapi)
- [`submodules-mojang` shows the same as `mojangapi`, but on the git submodules setup from `submodules`](https://github.com/PaperMC/paperweight-examples/tree/submodules-mojangapi)

## Setup
Note that when importing this project into your IDE of choice for the first time, you may experience an error such as `Could not create task ':generateDevelopmentBundle'.`. This is expected behavior - you should follow the instructions below to setup your workspace.

1. Clone this repo (e.g. `git clone https://github.com/PaperMC/paperweight-examples`)
2. Run the `applyPatches` gradle task and let it complete.
3. Open paperweight-examples in your IDE. Your IDE's import process should now succeed.