Skip to content

Commit 3e49eaa

Browse files
committed
Improve README.md, remove all occurences of pgm-template-repo
Signed-off-by: Gerrit Drost <gerrit.drost@alliander.com>
1 parent fe5ce1f commit 3e49eaa

2 files changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,25 @@ The PGM methods are available through class `org.lfenergy.pgm.PowerGridModelC`.
1414

1515
To load the native library there are two options:
1616
- on supported architectures, the library can be autoloaded using `PGMLoader.autoload()`
17-
- on other architecture, you can build and load the library yourself using `System.load(...)`, and verify if you've loaded it correctly using `PGMLoader.verifyLoaded()`.
17+
- on other architecture, you can build and load the library yourself using `System.load(...)`, and verify if you've loaded it correctly using `PGMLoader.check()`.
1818

1919
## Supported architectures
2020

21-
- Mac OS ARM64 (Apple with M1 chip and newer)
22-
- Mac OS x86-64 (Apple with Intel chips)
23-
- Linux ARM64 (e.g. Snapdragon CPU)
24-
- Linux x86-64 (Intel, AMD, etc.)
25-
- Windows x86-64 (Intel, AMD, etc.)
21+
- macOS ARM64
22+
- macOS x86-64
23+
- Linux ARM64
24+
- Linux x86-64
25+
- Windows x86-64
2626

2727

2828
## Checklist after creating a repository from this template
2929

3030
Update the following items manually before publishing your repository:
3131

32-
- [ ] Rename the repository and update all references in this file.
33-
- [ ] Replace all `pgm-template-repo` references across the repository, especially in this README and REUSE.toml.
34-
- [ ] Replace the project title and description in this README.
35-
- [ ] Ensure all third-party licenses are present in [LICENSES](https://github.com/PowerGridModel/pgm-template-repo/tree/main/LICENSES).
32+
- [x] Rename the repository and update all references in this file.
33+
- [x] Replace all `pgm-template-repo` references across the repository, especially in this README and REUSE.toml.
34+
- [x] Replace the project title and description in this README.
35+
- [ ] Ensure all third-party licenses are present in [LICENSES](https://github.com/PowerGridModel/libpower-grid-model-java/tree/main/LICENSES).
3636

3737
### Optional checks
3838

@@ -41,22 +41,22 @@ Change these if applicable.
4141
- [ ] Replace Power Grid Model project-specific links (for example contributing, support, release, security, and code of conduct links)
4242
with links for your project.
4343
- [ ] Add logos and badges corresponding to relevant pages
44-
- [ ] Verify [LICENSE](https://github.com/PowerGridModel/pgm-template-repo/blob/main/LICENSE) copyright holder and year(s).
44+
- [ ] Verify [LICENSE](https://github.com/PowerGridModel/libpower-grid-model-java/blob/main/LICENSE) copyright holder and year(s).
4545
Also verify SPDX copyright headers in source and documentation files.
4646
- [ ] Include documents present in [Home page of PGM org](https://github.com/PowerGridModel/.github/) in documentation if they are created.
4747

4848
## License
4949

5050
This project is licensed under the Mozilla Public License, version 2.0 - see
51-
[LICENSE](https://github.com/PowerGridModel/pgm-template-repo/blob/main/LICENSE) for details.
51+
[LICENSE](https://github.com/PowerGridModel/libpower-grid-model-java/blob/main/LICENSE) for details.
5252

5353
## Licenses third-party libraries
5454

5555
This project includes third-party libraries,
5656
which are licensed under their own respective Open-Source licenses.
5757
SPDX-License-Identifier headers are used to show which license is applicable.
5858
The concerning license files can be found in the
59-
[LICENSES](https://github.com/PowerGridModel/pgm-template-repo/tree/main/LICENSES) directory.
59+
[LICENSES](https://github.com/PowerGridModel/libpower-grid-model-java/tree/main/LICENSES) directory.
6060

6161
## Contributing
6262

REUSE.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
# SPDX-License-Identifier: MPL-2.0
44

55
version = 1
6-
SPDX-PackageName = "pgm-template-repo"
6+
SPDX-PackageName = "libpower-grid-model-java"
77
SPDX-PackageSupplier = "Power Grid Model project <powergridmodel@lfenergy.org>"
8-
SPDX-PackageDownloadLocation = "https://github.com/PowerGridModel/pgm-template-repo"
8+
SPDX-PackageDownloadLocation = "https://github.com/PowerGridModel/libpower-grid-model-java"
99

1010
[[annotations]]
1111
path = "./**"

0 commit comments

Comments
 (0)