MatthewPeterKelly/OptimTraj

Clean up installation

Open

#33 opened on Feb 3, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)MATLAB (704 stars) (219 forks)batch import
enhancementgood first issue

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

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Create an INSTALL.md file with step by step installation instructions for the OptimTraj library. Move all existing source code into a new src/ directory and update any internal references. Write a simple installation script (e.g., bash or MATLAB script) that sets up the library, with an optional flag to install example files. Review the current repository layout and ensure the script handles typical MATLAB paths.