Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: changing all urls from osrd-project OpenRailAssociation #85

Merged
merged 2 commits into from
Oct 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
7 changes: 7 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -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/).
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion python/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
2 changes: 1 addition & 1 deletion python/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
5 changes: 3 additions & 2 deletions wasm/html_demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
<main>
<div id="sidebar">
<h1>libLRS demonstrator</h1>
<p><a href="https://github.com/osrd-project/liblrs/">libLRS</a>is a library for modeling Linear Reference
<p><a href="https://github.com/OpenRailAssociation/liblrs/">libLRS</a>is a library for modeling Linear
Reference
Systems. Load your data to start testing.</a></p>
<div x-data="$store.lrms">
<div x-show="waiting">
Expand Down Expand Up @@ -94,4 +95,4 @@ <h4>List of anchors (or milestones)</h4>
</main>
</body>

</html>
</html>
2 changes: 1 addition & 1 deletion wasm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@
"version": "0.2.3",
"repository": {
"type": "git",
"url": "https://github.com/osrd-project/liblrs/"
"url": "https://github.com/OpenRailAssociation/liblrs/"
}
}
Loading