ARMmbed / ARMmbed/valinor

Readme - add more info how valinor works

Open
#22 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
7
Forks
9
PR merge metrics
No merged PRs in 30d

Description

I would like to add pointers for where to start if a tool tool is being added. To cover this list:
1. project generator tool support (+definitions for mcu/target)
2. valinor launcher (finds the tool, launches it)

We don't have docs in here, could be contributing.md or just in Readme.

@autopulated Your take for documenting valinor for contributors?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README and contributing.md, then trace the project generator tool support and the valinor launcher mentioned in the issue. Done means contributor documentation explains where to begin when adding a tool, including project-generator definitions for mcu/target and how the launcher finds and starts the tool.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.