stride3d / stride3d/stride-docs
Create/improve guides on how to clone, build and contribute code to the engine
Open
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 39
- Forks
- 74
- Avg merge
- 3h 36m
- Merged PRs (30d)
- 2
Description
The idea is to make the instructions so easy that even a new user who barely knows anything about git and dotnet could successfully clone and build the engine.
Some quircks that should probably be documented:
- how to fork the repository
- cloning
- fetching lfs files manually (tends to sometimes happen after major changes to the source code)
- descriptions for each of the
.sln_and.buildfiles -dev_suffixes- How to manually purge the nuget cache
- Instructions for linux
- Mention how to build and run the avalonia editor
- Location of the gamestudio bin (for building with the cli)
- Document commonly used build paramters
- Document all stride-exclusive build paramters
- Instructions on how to build Stride and Game Studio with a different graphics API
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing build instructions in the stride-docs repository and identify where contributor setup guidance belongs. Cover the listed fork, clone, LFS, build-file, cache, Linux, Avalonia editor, CLI, parameter, and graphics API topics. Done means a beginner can follow the guide to clone and build the engine and Game Studio.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100