Skip to content

Commit

Permalink
README: improve README (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
younesschrifi authored Sep 27, 2024
1 parent 128f107 commit f5ca7bc
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,35 @@ Check out: [OSRD primary repository](https://github.com/OpenRailAssociation/osrd
Build osrd-images with an example infrastructure:

```sh
# TODO
docker build -t osrd-images .
```

Run osrd-images on port 8080

```sh
docker run -p -d 8080:80 osrd-images
```

Test the server response and check that the schema of the json file `image_path.json` matches the structure of the src folder

```sh
curl https://localhost:8080/image_path.json
```

## Add a new category of images

To add new image categories, you must :
- Add a new folder named after the category in the ```/src``` folder.
- Add an image representing the category (```category.png``` or ```category.jpeg``` or category.jpg) with its ```.license``` file in the ```/src``` folder.
- Add the images in each category with their ```.license``` files

### Requirements

<img src="assets/dimensions_and_weight.png" alt="Dimensions and weightt"/>

Added images must have a 3:2 aspect ratio.
For the moment, the dimensions and sizes accepted are those shown in the image below. <br>
The recommended format is <strong> medium</strong>.
## Get in touch

Send an email at <[email protected]>, [open an issue](https://github.com/OpenRailAssociation/osrd/issues/new?labels=kind%3Aquestion&template=question.yaml), or join the [#public-general:osrd.fr](https://matrix.to/#/#public-general:osrd.fr) matrix channel.
Expand Down
Binary file added assets/dimensions_and_weight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions assets/dimensions_and_weight.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# SPDX-FileCopyrightText: Copyright © 2022 The OSRD Contributors
#
# SPDX-License-Identifier: LGPL-3.0-only

0 comments on commit f5ca7bc

Please sign in to comment.