jMonkeyEngine / jMonkeyEngine/sdk

Fix beginner tutorials to reflect project creation changes

Open
#504 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
348
Forks
104
Avg merge
4d 13h
Merged PRs (30d)
3

Description

https://wiki.jmonkeyengine.org/docs/3.4/sdk/project_creation.html

For example doesn't cover gradle, and fails to mention that there are two types of projects and build systems

Minimum fix would be to update page and say "Choose 'Basic Game (with Ant)'" to send users in the right direction. Fixed

Bonus points for a different section describing how to configure gradle projects. Added how to add dependencies in gradle projects and some of the file structure

But maybe we should just deprecate ant projects and remove references to them?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the project creation tutorial at wiki.jmonkeyengine.org/docs/3.4/sdk/project_creation.html and compare its instructions with the two project types and build systems mentioned in the issue. Update the tutorial so its Gradle guidance, dependency setup, and file-structure notes are accurate, then verify whether references to Ant projects still need to remain.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.