Skip to content

Commit d28180d

Browse files
committed
fix version in readme
1 parent 26dc24a commit d28180d

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
<img alt="HMC Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/Somesy/Somesy_Logo_Text.png" style="width: 50%; height: 50%;" />
2727
</div>
2828

29-
3029
# somesy
3130

3231
Somesy (**so**ftware **me**tadata **sy**nc) is a CLI tool to avoid messy software project metadata by keeping it in sync.
@@ -68,13 +67,14 @@ pip install somesy
6867

6968
### Configuring somesy
7069

71-
Yes, somesy is *another* tool with its own configuration. However, for your
70+
Yes, somesy is _another_ tool with its own configuration. However, for your
7271
project metadata it is hopefully the last file you need, and the only one you
7372
have to think about, `somesy` will take care of the others for you!
7473

7574
To get started, create a file named `somesy.toml`:
7675

7776
<!-- --8<-- [start:somesytoml] -->
77+
7878
```toml
7979
[project]
8080
name = "my-amazing-project"
@@ -106,6 +106,7 @@ publication_author = true
106106
[config]
107107
verbose = true # show detailed information about what somesy is doing
108108
```
109+
109110
<!-- --8<-- [end:somesytoml] -->
110111

111112
Alternatively, you can also add the somesy configuration to an existing
@@ -122,19 +123,19 @@ somesy sync
122123

123124
The information in your `somesy.toml` is used as the **primary and
124125
authoritative** source for project metadata, which is used to update all
125-
supported (and enabled) *target files*. You can find an overview of supported
126+
supported (and enabled) _target files_. You can find an overview of supported
126127
formats further below.
127128

128129
By default, `somesy` will create (if they did not exist) or update `CITATION.cff` and `codemeta.json` files in your repository.
129130
If you happen to use
130131

131-
* `pyproject.toml` (in Python projects),
132-
* `package.json` (in JavaScript projects),
133-
* `Project.toml` (in Julia projects),
134-
* `fpm.toml` (in Fortran projects),
135-
* `pom.xml` (in Java projects),
136-
* `mkdocs.yml` (in projects using MkDocs),
137-
* `Cargo.toml` (in Rust projects)
132+
- `pyproject.toml` (in Python projects),
133+
- `package.json` (in JavaScript projects),
134+
- `Project.toml` (in Julia projects),
135+
- `fpm.toml` (in Fortran projects),
136+
- `pom.xml` (in Java projects),
137+
- `mkdocs.yml` (in projects using MkDocs),
138+
- `Cargo.toml` (in Rust projects)
138139

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

@@ -158,44 +159,44 @@ file in the root folder of your repository:
158159
repos:
159160
# ... (your other hooks) ...
160161
- repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
161-
rev: "v0.3.0"
162+
rev: "v0.4.3"
162163
hooks:
163164
- id: somesy
164165
```
165166
166167
Note that `pre-commit` gives `somesy` the [staged](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F) version of files,
167168
so when using `somesy` with pre-commit, keep in mind that
168169

169-
* if `somesy` changed some files, you need to `git add` them again (and rerun pre-commit)
170-
* if you explicitly run `pre-commit`, make sure to `git add` all changed files (just like before a commit)
170+
- if `somesy` changed some files, you need to `git add` them again (and rerun pre-commit)
171+
- if you explicitly run `pre-commit`, make sure to `git add` all changed files (just like before a commit)
171172

172173
<!-- --8<-- [end:precommit] -->
173174

174175
## Supported File Formats
175176

176177
Here is an overview of all the currently supported files and formats.
177178

178-
| Input Formats | Status | | Target Formats | Status |
179-
| -------------- | ------ |-| ----------------------------- | ------ |
180-
| (.)somesy.toml | ✓ | | pyproject.toml _(poetry)_ | ✓ |
181-
| pyproject.toml | ✓ | | pyproject.toml _(setuptools)_ | ✓(1.) |
182-
| package.json | ✓ | | package.json _(JavaScript)_ | ✓(2.) |
183-
| Project.toml | ✓ | | Project.toml _(Julia)_ | ✓ |
184-
| fpm.toml | ✓ | | fpm.toml _(Fortran)_ | ✓(3.) |
185-
| | ✓ | | pom.toml _(Java)_ | ✓(4.) |
186-
| Cargo.toml | ✓ | | Cargo.toml _(Rust)_ | ✓ |
187-
| | | | mkdocs.yml | ✓(5.) |
188-
| | | | CITATION.cff | ✓ |
189-
| | | | codemeta.json | ✓(6.) |
179+
| Input Formats | Status | | Target Formats | Status |
180+
| -------------- | ------ | --- | ----------------------------- | ------ |
181+
| (.)somesy.toml | ✓ | | pyproject.toml _(poetry)_ | ✓ |
182+
| pyproject.toml | ✓ | | pyproject.toml _(setuptools)_ | ✓(1.) |
183+
| package.json | ✓ | | package.json _(JavaScript)_ | ✓(2.) |
184+
| Project.toml | ✓ | | Project.toml _(Julia)_ | ✓ |
185+
| fpm.toml | ✓ | | fpm.toml _(Fortran)_ | ✓(3.) |
186+
| | ✓ | | pom.toml _(Java)_ | ✓(4.) |
187+
| Cargo.toml | ✓ | | Cargo.toml _(Rust)_ | ✓ |
188+
| | | | mkdocs.yml | ✓(5.) |
189+
| | | | CITATION.cff | ✓ |
190+
| | | | codemeta.json | ✓(6.) |
190191

191192
**Notes:**
192193

193-
1. note that `somesy` does not support setuptools *dynamic fields*
194-
2. `package.json` only supports one author, so `somesy` will pick the *first* listed author
195-
3. `fpm.toml` only supports one author and maintainer, so `somesy` will pick the *first* listed author and maintainer
194+
1. note that `somesy` does not support setuptools _dynamic fields_
195+
2. `package.json` only supports one author, so `somesy` will pick the _first_ listed author
196+
3. `fpm.toml` only supports one author and maintainer, so `somesy` will pick the _first_ listed author and maintainer
196197
4. `pom.xml` has no concept of `maintainers`, but it can have multiple licenses (somesy only supports one main project license)
197198
5. `mkdocs.yml` is a bit special, as it is not a project file, but a documentation file. `somesy` will only update it if it exists and is enabled in the configuration
198-
6. unlike other targets, `somesy` will *re-create* the `codemeta.json` (i.e. do not edit it by hand!)
199+
6. unlike other targets, `somesy` will _re-create_ the `codemeta.json` (i.e. do not edit it by hand!)
199200

200201
<!-- --8<-- [end:quickstart] -->
201202

@@ -215,7 +216,6 @@ in the [repository](https://github.com/Materials-Data-Science-and-Informatics/so
215216
We kindly thank all
216217
[authors and contributors](https://materials-data-science-and-informatics.github.io/somesy/latest/credits).
217218

218-
219219
<div>
220220
<img style="vertical-align: middle;" alt="HMC Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png" width=50% height=50% />
221221
&nbsp;&nbsp;

0 commit comments

Comments
 (0)