Ludeme / Ludeme/LudiiTutorials

More detailed instructions in installing_this_repo.rst please!

Open
#1 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

contribution welcome documentation good first issue
Dominant language
Java
Stars
16
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I appreciate the IDE agnosticism of that document, but I think examples for each step (for a specific IDE) would go a long way toward making this project accessible to new users.

Additionally (and arguably this should be a separate issue or issues), there is no mention of how to then run any of the examples once the project is set up correctly.

It also should be noted that this step is not even required to get started writing games as `.lud` files, as those may be loaded at runtime into the Ludii Player application. So if your goal is to write a game for Ludii, you do not need to install the tutorials repository at all.

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

Open installing_this_repo.rst and review the existing setup steps first. Add concrete examples for a specific IDE, explain how to run the examples after setup, and clarify that .lud files can be loaded into the Ludii Player without installing this repository; the document should cover these paths without ambiguity.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.