update docs

Author: mustafasoylu

CHANGELOG.md

@@ -3,6 +3,10 @@
 Here we provide notes that summarize the most important changes in each released version.
 
 Please consult the changelog to inform yourself about breaking changes and security issues.
+## [Unreleased] - yyyy-mm-dd
+
+### Added
+* added julia support for `Project.toml` file
 
 ## [v0.3.1](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.3.1) <small>(2024-01-23)</small> { id="0.3.1" }
 

README.md

@@ -109,7 +109,7 @@ verbose = true     # show detailed information about what somesy is doing
 <!-- --8<-- [end:somesytoml] -->
 
 Alternatively, you can also add the somesy configuration to an existing
-`pyproject.toml` or `package.json` file. The somesy [manual](https://materials-data-science-and-informatics.github.io/somesy/main/manual/#somesy-input-file) contains examples showing how to do that.
+`pyproject.toml`, `package.json` or `Project.toml` file. The somesy [manual](https://materials-data-science-and-informatics.github.io/somesy/main/manual/#somesy-input-file) contains examples showing how to do that.
 
 ### Using somesy
 
@@ -125,7 +125,7 @@ authoritative** source for project metadata, which is used to update all
 supported (and enabled) *target files*. You can find an overview of supported
 formats further below.
 
-By default, `somesy` will create (if they did not exist) or update `CITATION.cff` and `codemeta.json` files in your repository. If you happen to use `pyproject.toml` (in Python projects) or `package.json` (in JavaScript projects), somesy would also update the respective information there.
+By default, `somesy` will create (if they did not exist) or update `CITATION.cff` and `codemeta.json` files in your repository. If you happen to use `pyproject.toml` (in Python projects), `package.json` (in JavaScript projects), or `Project.toml` (in Julia projects), somesy would also update the respective information there.
 
 You can see call available options with `somesy --help`,
 all of these can also be conveniently set in your `somesy.toml` file.
@@ -169,6 +169,7 @@ Here is an overview of all the currently supported files and formats.
 | (.)somesy.toml | ✓      | | pyproject.toml _(poetry)_     | ✓      |
 | pyproject.toml | ✓      | | pyproject.toml _(setuptools)_ | ✓(1.)  |
 | package.json   | ✓      | | package.json                  | ✓(2.)  |
+| Project.toml   | ✓      | | Project.toml                  | ✓      |
 |                |        | | CITATION.cff                  | ✓      |
 |                |        | | codemeta.json                 | ✓(3.)  |
 

docs/manual.md

@@ -127,20 +127,20 @@ some of the currently supported formats.
 
 === "Project Metadata"
 
-    | Field Name        | Poetry Config | SetupTools Config | CITATION.cff    | package.json | Requirement |
-    | ----------------- | ------------- | ----------------- | --------------- | ------------ | ----------- |
-    | name              | name          | name              | title           | name         | required    |
-    | description       | description   | description       | abstract        | description  | required    |
-    | license           | license       | license           | license         | license      | required    |
-    | version           | version       | version           | version         | version      | optional    |
-    |                   |               |                   |                 |              |             |
-    | *author=true*     | authors       | authors           | authors         | author       | required    |
-    | *maintainer=true* | maintainers   | maintainers       | contact         | maintainers  | optional    |
-    | *people*          | -             | -                 | -               | contributors | optional    |
-    |                   |               |                   |                 |              |             |
-    | keywords          | keywords      | keywords          | keywords        | keywords     | optional    |
-    | repository        | repository    | urls.repository   | repository_code | repository   | optional    |
-    | homepage          | homepage      | urls.homepage     | url             | homepage     | optional    |
+    | Field Name        | Poetry Config | SetupTools Config | Julia Config || CITATION.cff    | package.json | Requirement |
+    | ----------------- | ------------- | ----------------- | ------------ || --------------- | ------------ | ----------- |
+    | name              | name          | name              | name         || title           | name         | required    |
+    | description       | description   | description       | -            || abstract        | description  | required    |
+    | license           | license       | license           | -            || license         | license      | required    |
+    | version           | version       | version           | version      || version         | version      | optional    |
+    |                   |               |                   |              ||                 |              |             |
+    | *author=true*     | authors       | authors           | authors      || authors         | author       | required    |
+    | *maintainer=true* | maintainers   | maintainers       | -            || contact         | maintainers  | optional    |
+    | *people*          | -             | -                 | -            || -               | contributors | optional    |
+    |                   |               |                   |              ||                 |              |             |
+    | keywords          | keywords      | keywords          | -            || keywords        | keywords     | optional    |
+    | repository        | repository    | urls.repository   | =            || repository_code | repository   | optional    |
+    | homepage          | homepage      | urls.homepage     | -            || url             | homepage     | optional    |
 
 Note that the mapping is often not 1-to-1. For example, CITATION.cff allows rich
 specification of author contact information and complex names. In contrast,
@@ -167,6 +167,7 @@ Without an input file specifically provided, somesy will check if it can find a
 * `.somesy.toml`
 * `somesy.toml`
 * `pyproject.toml` (in `tool.somesy` section)
+* `Project.toml` (in `tool.somesy` section)
 * `package.json` (in `somesy` section)
 
 which is located in the current working directory. If you want to provide
@@ -218,6 +219,44 @@ one of the supported input formats:
     verbose = true     # show detailed information about what somesy is doing
     ```
 
+=== "Project.toml"
+    ```toml
+    name = "my-amazing-project"
+    version = "0.1.0"
+    uuid = "c7e460c6-3f3e-11ec-8d3d-0242ac130003"
+
+    [deps]
+    ...
+
+    [tool.somesy.project]
+    name = "my-amazing-project"
+    version = "0.1.0"
+    description = "Brief description of my amazing software."
+
+    keywords = ["some", "descriptive", "keywords"]
+    license = "MIT"
+    repository = "https://github.com/username/my-amazing-project"
+
+    # This is you, the proud author of your project
+    [[tool.somesy.project.people]]
+    given-names = "Jane"
+    family-names = "Doe"
+    email = "j.doe@example.com"
+    orcid = "https://orcid.org/0000-0000-0000-0001"
+    author = true      # is a full author of the project (i.e. appears in citations)
+    maintainer = true  # currently maintains the project (i.e. is a contact person)
+
+    # this person is a acknowledged contributor, but not author or maintainer:
+    [[tool.somesy.project.people]]
+    given-names = "Another"
+    family-names = "Contributor"
+    email = "a.contributor@example.com"
+    orcid = "https://orcid.org/0000-0000-0000-0002"
+
+    [tool.somesy.config]
+    verbose = true     # show detailed information about what somesy is doing
+    ```
+
 === "package.json"
 
     ```json