MatthewPeterKelly / MatthewPeterKelly/OptimTraj
Clean up installation
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- MATLAB
- Stars
- 703
- Forks
- 219
- PR merge metrics
- No merged PRs in 30d
Description
Make it clear to users how to install this library.
- Add a INSTALL.md file
- Move source code into a src/ directory
- Add a simple installation script to add the library
- include a flag to optionally install examples
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 reviewing the repository layout and locating the current MATLAB source files and examples. Then outline the requested INSTALL.md, src/ relocation, and installation script, including the optional examples flag. Done means users have clear installation instructions and the library and examples can be installed through the documented process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- matlab
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100