feat(doc): 📝 add CITATION file

Add CITATION.cff and update init script for metadata

Introduces a CITATION.cff file to provide citation metadata for the project,
adhering to the citation-file-format standard.

Enhances the `init` script to support customizable project title and author
details, enabling dynamic updates to metadata files like LICENSE and CITATION.

Improves maintainability by refactoring file reading logic into a reusable
function and adding support for resetting the citation file template.

Author: djmaxus

.cspell.json

@@ -2,6 +2,10 @@
     "version": "0.2",
     "language": "en",
     "words": [
+        "djmaxus",
+        "Elizarev",
+        "Maksim",
+        "ORCID",
         "ruleset",
         "Rulesets",
         "Simulink"

.gitattributes

@@ -24,3 +24,4 @@ README.md                         export-ignore
 version.txt                       export-ignore
 test.m                            export-ignore
 .gitignore                        export-ignore
+CITATION.cff                      export-ignore

.vscode/settings.json

@@ -8,4 +8,9 @@
         "action-patch",
         "init"
     ],
+    "yaml.schemas": {
+        "https://raw.githubusercontent.com/citation-file-format/citation-file-format/main/schema.json": [
+            "CITATION.cff"
+        ]
+    }
 }

CITATION.cff

@@ -0,0 +1,31 @@
+# https://github.com/citation-file-format/citation-file-format
+cff-version: 1.2.0
+type: software
+message: >-
+  If you use this software,
+  please put the copyright NOTICE.txt in your developments
+  and cite it using metadata in this file.
+# doi:
+title: "Template GitHub repository for open-source MATLAB"
+authors:
+  - &djmaxus
+    family-names: Elizarev
+    given-names: Maksim
+    alias: djmaxus
+    orcid: "https://orcid.org/0000-0002-5279-2877"
+    website: "https://djmaxus.dev"
+contact:
+  - *djmaxus
+keywords:
+  - MATLAB
+  - Template repository
+  - CI/CD
+  - Semantic Versioning
+  - License
+  - Release automation
+  - Github Actions
+  - github.io page
+license: BSD-3-Clause
+repository-code: "https://github.com/djmaxus/matlab-repo-init"
+url: "https://matlab-template.djmaxus.dev"
+abstract: "Wiki: https://github.com/djmaxus/matlab-repo-init/wiki"

CITATION.cff.template

@@ -0,0 +1,8 @@
+# https://github.com/citation-file-format/citation-file-format
+cff-version: 1.2.0
+type: software
+message: >-
+  If you use this software,
+  please put the copyright NOTICE.txt in your developments
+  and cite it using metadata in this file.
+# doi:

init.m

@@ -1,4 +1,4 @@
-function [] = init(year,full_name,args)
+function [] = init(year,first_name,last_name,project_title,args)
 % Main initialization script
 %
 %   BSD 3-Clause License
@@ -31,7 +31,9 @@
 %   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 arguments
     year (1,1) int32
-    full_name char
+    first_name char
+    last_name char
+    project_title char
     args.self_delete (1,1) logical = true;
     args.reset_test (1,1) logical = true;
 end
@@ -46,7 +48,7 @@
 delete_file('version.txt');
 
 reset_file('README.md', ...
-"# README\n\n" + ...
+"# " + project_title + "\n\n" + ...
 "![CI](../../actions/workflows/ci.yml/badge.svg?branch=main)\n\n"+...
 "## Source Template Repository\n\n"+...
 "Generated from matlab-repo-init\n\n"+...
@@ -71,12 +73,16 @@
 'ignoreWords',[]);
 reset_file('.cspell.json',jsonencode(cspell_default,PrettyPrint=true)+"\n");
 
-rmdir('.vscode','s');
-rmdir('.github/actions','s');
+rmdir('.vscode','s'); % TODO keep cff schema in settings
+rmdir('.github/actions','s'); % TODO add printed notification
 
 % Set license details
+full_name = [first_name, ' ', last_name];
 set_license('LICENSE',year,full_name);
 
+% CITATION.cff
+reset_cff(first_name,last_name,project_title);
+
 if ~args.self_delete
     return;
 end
@@ -108,24 +114,41 @@ function reset_file(name,lines)
 function set_license(file_name,year,full_name)
 full_file = fullfile(pwd, file_name);
 
-[fid, err_msg] = fopen(full_file,'r');
-if fid == -1
-    error(['Could not open ', name,' for reading: ',err_msg]);
-end
-license_text=fread(fid,'*char')';
-fclose(fid);
+license_text=read_to_char(file_name);
 
 upd_license_text = regexprep(license_text,'Copyright \(c\) (.*?)\n', ...
     ['Copyright (c) ',num2str(year),', ', full_name,'\n']);
 
 [fid, err_msg] = fopen(full_file,'w');
 if fid == -1
-    error(['Could not open ', name,' for writing: ',err_msg]);
+    error(['Could not open ', file_name,' for writing: ',err_msg]);
 end
 fprintf(fid,'%s',upd_license_text);
 fclose(fid);
 end
 
+function reset_cff(first_name,last_name,project_title)
+cff_template = read_to_char('CITATION.cff.template');
+delete_file('CITATION.cff.template');
+
+reset_file('CITATION.cff', cff_template + ...
+"title: """ + project_title + """\n" + ...
+"authors:\n" + ...
+"  - family-names: " + last_name + "\n" + ...
+"    given-names: " + first_name + "\n"...
+);
+end
+
+function read_char = read_to_char(file_name)
+full_file = fullfile(pwd, file_name);
+[fid, err_msg] = fopen(full_file,'r');
+if fid == -1
+    error(['Could not open ', file_name,' for reading: ',err_msg]);
+end
+read_char = fread(fid,'*char')';
+fclose(fid);
+end
+
 function print_info()
 [fid, ~] = fopen('version.txt','r');
 version_str=fread(fid,'*char')';

test.m

@@ -1 +1 @@
-init(1984, 'George Orwell', self_delete=false, reset_test=false);
+init(1984, 'George', 'Orwell', '1984', self_delete=false, reset_test=false);