Plsm icon indicating copy to clipboard operation
Plsm copied to clipboard

Add documentation

Open jhartwell opened this issue 7 years ago • 4 comments

Currently there is little to no documentation in the code base, which is not good.

jhartwell avatar Jan 18 '18 15:01 jhartwell

The readme could also use some clarification. The things I noticed were:

  1. It would read better if "Getting Plsm" was before "Running Plsm"
  2. Make it clearer that generating the config file will append your existing config file instead of deleting it.
  3. Give an example for the "destination" field. I have no idea where the models should actually go when generated.

whossname avatar May 05 '18 09:05 whossname

Thanks for this tool btw. I just figured out the "destination" thing and generated the models.

whossname avatar May 05 '18 09:05 whossname

@whossname, thanks for the feedback. I will update the readme this week

jhartwell avatar May 07 '18 14:05 jhartwell

README has been updated. There will be more documentation added along the way as well

jhartwell avatar Jun 18 '18 19:06 jhartwell