diff --git a/README.md b/README.md index f31d7fb..cdefd84 100644 --- a/README.md +++ b/README.md @@ -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 + + 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.
+The recommended format is medium. ## Get in touch Send an email at , [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. diff --git a/assets/dimensions_and_weight.png b/assets/dimensions_and_weight.png new file mode 100644 index 0000000..7cb79c7 Binary files /dev/null and b/assets/dimensions_and_weight.png differ diff --git a/assets/dimensions_and_weight.png.license b/assets/dimensions_and_weight.png.license new file mode 100644 index 0000000..85678ba --- /dev/null +++ b/assets/dimensions_and_weight.png.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: Copyright © 2022 The OSRD Contributors +# +# SPDX-License-Identifier: LGPL-3.0-only