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.

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

"Setting up a Development Environment" Guide doesn't mention non automatic gradle project import #71

Open
Felan7 opened this issue Dec 20, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@Felan7
Copy link

Felan7 commented Dec 20, 2023

Operating System

Windows

Web Browser

Chrome

Issue description

The Setup Guide doesn't mention the fact that when you are not using IntelliJ IDEA (which in fairness is the recommended IDE), the gradle project is not automatically imported. This has to be done via running the gradlew terminal command.

I understand that the getting started guide is not, and should not be a gradle tutorial, but I feel a couple lines pointing this out won't hurt. I found this solution in the setup guide for NeoForged by the way.

Another minor issue unrelated to the first is a possible typo in the code snippet for gradle.properties in the same guide. Feels to me like the last line (archives_base_name = bingus-mod) should be "bingus_mod"? Not entirely sure though.

@Felan7 Felan7 added the bug Something isn't working label Dec 20, 2023
@ix0rai
Copy link
Member

ix0rai commented Dec 20, 2023

the reason it's hyphenated is because archives_base_name is a property uniquely used for maven -- maven uses hyphens, as you can see from browsing the names in our repository

@ix0rai
Copy link
Member

ix0rai commented Dec 20, 2023

I've fixed the maven issue, but I think that the setup should have separate sections for different IDEs -- Eclipse, Intellij, Vscode, and "Other"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants