Skip to content

Commit 21dfc9c

Browse files
mustafasoylumustafasoylu
committed
update docs
1 parent 742e0a6 commit 21dfc9c

3 files changed

Lines changed: 29 additions & 24 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Please consult the changelog to inform yourself about breaking changes and secur
1111
* added support for Fortran `fpm.toml` file
1212
* added support for Java `pom.xml` file
1313
* added support for MkDocs `mkdocs.yml` file
14+
* added support for Rust `Cargo.toml` file
1415

1516
## [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" }
1617

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ If you happen to use
134134
* `fpm.toml` (in Fortran projects),
135135
* `pom.xml` (in Java projects),
136136
* `mkdocs.yml` (in projects using MkDocs),
137+
* `Cargo.toml` (in Rust projects)
137138

138139
then somesy would also update the respective information there.
139140

@@ -182,6 +183,7 @@ Here is an overview of all the currently supported files and formats.
182183
| Project.toml | ✓ | | Project.toml _(Julia)_ | ✓ |
183184
| fpm.toml | ✓ | | fpm.toml _(Fortran)_ | ✓(3.) |
184185
| | ✓ | | pom.toml _(Java)_ | ✓(4.) |
186+
| Cargo.toml | ✓ | | Cargo.toml _(Rust)_ | ✓ |
185187
| | | | mkdocs.yml | ✓(5.) |
186188
| | | | CITATION.cff | ✓ |
187189
| | | | codemeta.json | ✓(6.) |

‎docs/manual.md‎

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -117,33 +117,34 @@ some of the currently supported formats. Bold field names are mandatory, the oth
117117

118118
=== "Person Metadata"
119119

120-
| Somesy Field | Poetry Config | SetupTools Config | Java POM | Julia Config | Fortran Config | package.json | mkdocs.yml | CITATION.cff | CodeMeta |
121-
| ---------------- | ------------- | ----------------- | ------------ | ------------ | -------------- | ------------ | ---------- | --------------- | --------------- |
122-
| | | | | | | | | | |
123-
| **given-names** | name+email | name | name | name+email | name+email | name | name+email | given-names | givenName |
124-
| **family-names** | name+email | name | name | name+email | name+email | name | name+email | family-names | familyName |
125-
| **email** | name+email | email | email | name+email | name+email | email | name+email | email | email |
126-
| orcid | - | - | url | - | - | url | - | orcid | id |
127-
| *(many others)* | - | - | - | - | - | - | - | *(same)* | *(same)* |
120+
| Somesy Field | Poetry Config | SetupTools Config | Java POM | Julia Config | Fortran Config | package.json | mkdocs.yml | Rust Config | CITATION.cff | CodeMeta |
121+
| ---------------- | ------------- | ----------------- | ------------ | ------------ | -------------- | ------------ | ---------- | -------------- | --------------- | -------------- |
122+
| | | | | | | | | | | |
123+
| **given-names** | name+email | name | name | name+email | name+email | name | name+email | name+email | givenName | name+email |
124+
| **family-names** | name+email | name | name | name+email | name+email | name | name+email | name+email | familyName | name+email |
125+
| **email** | name+email | email | email | name+email | name+email | email | name+email | name+email | email | name+email |
126+
| orcid | - | - | url | - | - | url | - | - | id | - |
127+
| *(many others)* | - | - | - | - | - | - | - | - | *(same)* | - |
128128

129129
=== "Project Metadata"
130130

131-
| Somesy Field | Poetry Config | SetupTools Config | Java POM | Julia Config | Fortran Config | package.json | mkdocs.yml | CITATION.cff | CodeMeta |
132-
| ----------------- | ------------- | ------------------ | ------------------------------- | ------------ | -------------- | ------------ | ---------------- | --------------- | ----------------- |
133-
| | | | | | | | | | |
134-
| **name** | name | name | name | name | name | name | site_name | title | name |
135-
| **description** | description | description | description | - | description | description | site_description | abstract | description |
136-
| **license** | license | license | licenses.license | - | license | license | - | license | license |
137-
| **version** | version | version | version | version | version | version | - | version | version |
138-
| | | | | | | | | | |
139-
| ***author=true*** | authors | authors | developers | authors | author | author | site_author | authors | author |
140-
| *maintainer=true* | maintainers | maintainers | - | - | maintainer | maintainers | - | contact | maintainer |
141-
| *people* | - | - | - | - | - | contributors | - | - | contributor |
142-
| | | | | | | | | | |
143-
| keywords | keywords | keywords | - | - | keywords | keywords | - | keywords | keywords |
144-
| homepage | homepage | urls.homepage | urls | - | homepage | homepage | site_url | url | url |
145-
| repository | repository | urls.repository | scm.url | - | - | repository | repo_url | repository_code | codeRepository |
146-
| documentation | documentation | urls.documentation | distributionManagement.site.url | - | - | - | - | - | buildInstructions |
131+
| Somesy Field | Poetry Config | SetupTools Config | Java POM | Julia Config | Fortran Config | package.json | mkdocs.yml | Rust Config | CITATION.cff | CodeMeta |
132+
| ----------------- | ------------- | ------------------ | ------------------------------- | ------------ | -------------- | ------------ | ---------------- | --------------- | --------------- | ----------------- |
133+
| | | | | | | | | | | |
134+
| **name** | name | name | name | name | name | name | site_name | name | title | name |
135+
| **description** | description | description | description | - | description | description | site_description | description | abstract | description |
136+
| **license** | license | license | licenses.license | - | license | license | - | license | license | license |
137+
| **version** | version | version | version | version | version | version | - | version | version | version |
138+
| | | | | | | | | | | |
139+
| ***author=true*** | authors | authors | developers | authors | author | author | site_author | authors | authors | author |
140+
| *maintainer=true* | maintainers | maintainers | - | - | maintainer | maintainers | - | - | contact | maintainer |
141+
| *people* | - | - | - | - | - | contributors | - | - | - | contributor |
142+
| | | | | | | | | | | |
143+
| keywords | keywords | keywords | - | - | keywords | keywords | - | keywords | keywords | keywords |
144+
| homepage | homepage | urls.homepage | urls | - | homepage | homepage | site_url | homepage | url | url |
145+
| repository | repository | urls.repository | scm.url | - | - | repository | repo_url | repository | repository_code | codeRepository |
146+
| documentation | documentation | urls.documentation | distributionManagement.site.url | - | - | - | - | documentation | - | buildInstructions |
147+
147148

148149
Note that the mapping is often not 1-to-1. For example, CITATION.cff allows rich
149150
specification of author contact information and complex names. In contrast,
@@ -173,6 +174,7 @@ Without an input file specifically provided, somesy will check if it can find a
173174
* `Project.toml` (in `tool.somesy` section)
174175
* `fpm.toml` (in `tool.somesy` section)
175176
* `package.json` (in `somesy` section)
177+
* `Cargo.toml` (in `package.metadata.somesy` section)
176178

177179
which is located in the current working directory. If you want to provide
178180
the somesy input file from a different location, you can pass it with the `-i` option.

0 commit comments

Comments
 (0)