bpancras / FSDA

Flexible Statistics and Data Analysis (FSDA) extends MATLAB for a robust analysis of data sets affected by different sources of heterogeneity. It is open source software licensed under the European Union Public Licence (EUPL). FSDA is a joint project by the University of Parma and the Joint Research Centre of the European Commission.
https://uniprjrc.github.io/FSDA/
European Union Public License 1.1
0 stars 0 forks source link

Reorganizing the root folder #2

Open bpancras opened 1 year ago

bpancras commented 1 year ago

Remove the following files from the root folder

  1. ./poster_FSDA.pdf
  2. ./404.md
  3. ./addFSDA2path.m- this is no longer needed since we are using MLTBX files for installing the toolbox
  4. ./InstallationNotes.docx- not GitHub friendly

Files that need to be modified

  1. ./eupllicense.pdf→license.md
  2. readme.md→ README.md - following the convention
  3. ./InstallationNotes.pdf→ README.md- following the convention
  4. ./Copyright notice.pdf→COPYRIGHT.md- Following the convention
  5. logo.png, logo50x50.png, logoblue.jpg → ./images/

Caution- files impacted

  1. Toolbox packaging PRJ- change the path of logo
  2. Apps PRJ file- change the path to logo
AldoCorbelliniUNIPR commented 10 months ago

1) In the 'MATLAB Toolbox Best Practices' (https://github.com/mathworks/toolboxdesign) the suggestion was to have a file called 'license.txt' but we opted to create a file called 'license.md' as per your instructions. Is it correct? 2) in the root folder of FSDA we have this subfolder called '/release' that is connected to this PR (https://github.com/UniprJRC/FSDA/pull/57). Can we safely remove it?

bpancras commented 9 months ago

i. md files are GitHub friendly, we do not have reservations between txt and md files. license.txt is only a historic artifact. ii. Yes, you can safely remove it. The release folder should not be under version control. It is much safer to add the release folder to the .gitignore file.