s-hunt/foiltrack

foiltrack's Issues

Check license

Two parts to this. First, are we okay with GPL? Second, are we okay to include other code (need to check original source). Need to check the following:

• Jacobianest.m
• GetCases.m
• /splinefit
• /esrf-pmedf
• idctn.m
• dtcn.m
• smoothn.m

Note that Jacobianest.m is needed for errors in some parts of the code and the last three files may not be needed any longer. Document these in the README file.

File version numbers

Version numbers are read from file headers which are undated manually. It should be changed to use the git commit or release number.

Add pointers to encourage citations

If anybody ends up using this code we want to encourage them to cite a paper. Maybe just text in the README, but maybe a CITATION file? Or print out something?

Turn on github pages

This will create a web page of the stuff in docs.

Tidy up root

Put most of files in a subdirectory (that gets pointed to when added as a toolbox) so that support code, the README, and so is easer to find, and does not get added to the matlab path thingy.

Move documentation from word to markdown

Moving the documentation into markdown will mean it is easer to read on the web.

Create release and DOI

Suggest we call the version referenced on submission version 1.0.0 and increment this for a new version in the (unlikely) event that we need to make changes and cut a new release for revisions to the manuscript.

This is the last task, but needs to be done before submitting the manuscript / uploading a preprint (so the DOI can be included). First step is to make the repository public. Then we follow instructions at https://guides.github.com/activities/citable-code/