From 2e823dcd31bb29cba08d5299eec703819b14a772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tristram=20Gr=C3=A4bener?= Date: Wed, 23 Oct 2024 15:04:14 +0200 Subject: [PATCH 1/2] doc: changing all urls from osrd-project OpenRailAssociation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Tristram Gräbener --- CONTRIBUTING.md | 8 ++++---- Cargo.toml | 2 +- README.md | 4 ++-- python/Cargo.toml | 2 +- python/README.md | 2 +- wasm/html_demo/index.html | 5 +++-- wasm/package.json | 2 +- 7 files changed, 13 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb978f0..6cb8d17 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,15 +2,15 @@ All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. -Check out our community's [Code of Conduct](https://github.com/osrd-project/liblrs/blob/main/CODE_OF_CONDUCT.md) and feel free to say hi on [matrix](https://matrix.to/#/#liblrs:osrd.fr) if you'd like. It's a nice place to chat about libLRS development, ask questions, and get to know the other contributors and users in a less formal setting. +Check out our community's [Code of Conduct](https://github.com/OpenRailAssociation/liblrs/blob/main/CODE_OF_CONDUCT.md) and feel free to say hi on [matrix](https://matrix.to/#/#liblrs:osrd.fr) if you'd like. It's a nice place to chat about libLRS development, ask questions, and get to know the other contributors and users in a less formal setting. ## Getting oriented The libLRS project has only one repo, but with subproject for the bindings: -1. [`rust`](https://github.com/osrd-project/liblrs/tree/main/src): the core of the library. -2. [`python`](https://github.com/osrd-project/liblrs/tree/main/python): the python bindings (using [`pyO2`](https://pyo3.rs/)). -3. [`wasm`](https://github.com/osrd-project/liblrs/tree/main/wasm): the javascript bindings (using [`wasm-bindgen`](https://github.com/osrd-project/liblrs/tree/main/wasm)). +1. [`rust`](https://github.com/OpenRailAssociation/liblrs/tree/main/src): the core of the library. +2. [`python`](https://github.com/OpenRailAssociation/liblrs/tree/main/python): the python bindings (using [`pyO2`](https://pyo3.rs/)). +3. [`wasm`](https://github.com/OpenRailAssociation/liblrs/tree/main/wasm): the javascript bindings (using [`wasm-bindgen`](https://github.com/OpenRailAssociation/liblrs/tree/main/wasm)). ## What we are trying to build diff --git a/Cargo.toml b/Cargo.toml index d9366b5..c36d9e9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ version = "0.2.3" edition = "2021" description = "Library to manipulate linear referencing systems" license = "MIT" -homepage = "https://github.com/osrd-project/liblrs/" +homepage = "https://github.com/OpenRailAssociation/liblrs/" [workspace] members = ["wasm", "python"] diff --git a/README.md b/README.md index e34daa9..280b809 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ npm build ### Demonstrator -A simple HTML demonstrator allows to test the data and the functions. It is available online at https://osrd-project.github.io/liblrs/. +A simple HTML demonstrator allows to test the data and the functions. It is available online at https://OpenRailAssociation.github.io/liblrs/. To run locally: @@ -65,7 +65,7 @@ MAPLIBRE_STYLE="https://your_tile_provider/style.json?key=42" npm run serve The library is also exposed as python bindings and published on [PyPI](https://pypi.org/project/liblrs-python/). -See the dedicated [directory](https://github.com/osrd-project/liblrs/tree/main/python) for more informations. +See the dedicated [directory](https://github.com/OpenRailAssociation/liblrs/tree/main/python) for more informations. ### Data serialization with FlatBuffers diff --git a/python/Cargo.toml b/python/Cargo.toml index 51da21c..58df52a 100644 --- a/python/Cargo.toml +++ b/python/Cargo.toml @@ -4,7 +4,7 @@ description = "Python bindings for liblrs: a library to work with linear referen version = "0.2.3" edition = "2021" license = "MIT" -repository = "https://github.com/osrd-project/liblrs/" +repository = "https://github.com/OpenRailAssociation/liblrs/" [lib] crate-type = ["cdylib"] diff --git a/python/README.md b/python/README.md index 432e972..053d3e6 100644 --- a/python/README.md +++ b/python/README.md @@ -1,6 +1,6 @@ # LibLRS Python -Expose [liblrs](https://github.com/osrd-project/liblrs/) through [pyO3](https://pyo3.rs). +Expose [liblrs](https://github.com/OpenRailAssociation/liblrs/) through [pyO3](https://pyo3.rs). ## Usage diff --git a/wasm/html_demo/index.html b/wasm/html_demo/index.html index 1f28ff7..be3bfd5 100644 --- a/wasm/html_demo/index.html +++ b/wasm/html_demo/index.html @@ -44,7 +44,8 @@
- \ No newline at end of file + diff --git a/wasm/package.json b/wasm/package.json index d349315..3d68c5b 100644 --- a/wasm/package.json +++ b/wasm/package.json @@ -24,6 +24,6 @@ "version": "0.2.3", "repository": { "type": "git", - "url": "https://github.com/osrd-project/liblrs/" + "url": "https://github.com/OpenRailAssociation/liblrs/" } } From c331c76ba3b0d1163a7a82afefd4b3371cecae02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tristram=20Gr=C3=A4bener?= Date: Wed, 23 Oct 2024 15:08:23 +0200 Subject: [PATCH 2/2] doc: add MAINTAINERS.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Tristram Gräbener --- MAINTAINERS.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..a40db20 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,7 @@ +# Maintainers + +[This document](https://github.com/OpenRailAssociation/openrail-org-config/blob/main/teams/liblrs.yaml) lists the Maintainers of the Project. Maintainers may be added once approved by the existing maintainers as described in the [Governance document](./GOVERNANCE.md). By adding your name to the yaml file you are agreeing to abide by the Project governance documents and to abide by all of the Organization's policies, including the [code of conduct](./CODE_OF_CONDUCT.md). If you are participating because of your affiliation with another organization (designated below), you represent that you have the authority to bind that organization to these policies. + +--- + +Based on [GitHub's Minimum Viable Governance (MVG)](https://github.com/github/MVG). Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by/4.0/).