diff --git a/README.md b/README.md index b6a51cf..70e431a 100644 --- a/README.md +++ b/README.md @@ -3,35 +3,27 @@ Logo of gpx.studio. -[**gpx.studio**](https://gpx.studio) is an online tool for creating and editing GPX files. +* [**gpx.studio**](https://gpx.studio) est un outil en ligne pour créer et éditer des fichiers GPX. +* ![gpx.studio screenshot](website/src/lib/assets/img/docs/getting-started/interface.png) -This repository contains the source code of the website. +Ce dépôt contient le code source du site. -## Contributing +## Traduction -Please create an issue if you find a bug or have a feature request. +Le site Web est traduit par des bénévoles sur une plateforme de traduction collaborative. +Vous pouvez aider à compléter et à améliorer les traductions en rejoignant le projet [Crowdin](https://crowdin.com/project/gpxstudio). -Code contributions are also welcome, but except for obvious bug fixes, please open an issue first to discuss the changes you would like to make. +## Développement -## Translation +Le code est divisé en deux parties: +- `gpx`: une bibliothèque de caractères pour analyser et manipuler les fichiers GPX, +- `site web`: le site lui-même, qui est une application [SvelteKit](https://kit.svelte.dev/). -The website is translated by volunteers on a collaborative translation platform. -You can help complete and improve the translations by joining the [Crowdin project](https://crowdin.com/project/gpxstudio). -If you would like to start the translation in a new language, please contact me or create an issue. +Vous aurez besoin de [Node.js](https://nodejs.org/) pour construire et exécuter ces deux parties. -Any help is greatly appreciated! - -## Development - -The code is split into two parts: -- `gpx`: a Typescript library for parsing and manipulating GPX files, -- `website`: the website itself, which is a [SvelteKit](https://kit.svelte.dev/) application. - -You will need [Node.js](https://nodejs.org/) to build and run these two parts. - -### Building the `gpx` library +### Construction de la bibliothèque `gpx` ```bash cd gpx @@ -39,9 +31,9 @@ npm install npm run build ``` -### Running the website +### Fonctionnement du site -To be able to load the map, you will need to create your own Mapbox access token and store it in a `.env` file in the `website` directory. +Pour pouvoir charger la carte, vous devrez créer votre propre Jeton d'accès Mapbox et le stocker dans un fichier `.env` dans le répertoire `site web`. ```bash cd website @@ -50,31 +42,30 @@ npm install npm run dev ``` -## Credits +## Crédits -This project has been made possible thanks to the following open source projects: +Ce projet a été rendu possible grâce aux projets open source suivants: -- Development: - - [Svelte](https://github.com/sveltejs/svelte) and [SvelteKit](https://github.com/sveltejs/kit) — seamless development experience - - [MDsveX](https://github.com/pngwn/MDsveX) — allowing a Markdown-based documentation - - [svelte-i18n](https://github.com/kaisermann/svelte-i18n) — easy localization -- Design: +- Développement: + - [Svelte](https://github.com/sveltejs/svelte) and [SvelteKit](https://github.com/sveltejs/kit) — expérience de développement sans faille + - [MDsveX](https://github.com/pngwn/MDsveX) — permettant une documentation basée sur Markdown + - [svelte-i18n](https://github.com/kaisermann/svelte-i18n) — localisation facile +- Conception: - [shadcn-svelte](https://github.com/huntabyte/shadcn-svelte) — beautiful components - - [lucide-svelte](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-svelte) — beautiful icons - - [tailwindcss](https://github.com/tailwindlabs/tailwindcss) — easy styling - - [Chart.js](https://github.com/chartjs/Chart.js) — beautiful and fast charts -- Logic: - - [immer](https://github.com/immerjs/immer) — complex state management - - [Dexie.js](https://github.com/dexie/Dexie.js) — IndexedDB wrapper - - [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) — fast GPX file parsing - - [SortableJS](https://github.com/SortableJS/Sortable) — creating a sortable file tree -- Mapping: - - [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) — beautiful and fast interactive maps - - [brouter](https://github.com/abrensch/brouter) — routing engine - - [OpenStreetMap](https://www.openstreetmap.org) — map data used by Mapbox and brouter -- Search: - - [DocSearch](https://github.com/algolia/docsearch) — search engine for the documentation + - [lucide-svelte](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-svelte) — belles icônes + - [tailwindcss](https://github.com/tailwindlabs/tailwindcss) — un style facile + - [Chart.js](https://github.com/chartjs/Chart.js) — beaux et rapides graphiques +- Logique: + - [immer](https://github.com/immerjs/immer) — gestion d'État complexe + - [Dexie.js](https://github.com/dexie/Dexie.js) — Emballage IndexedDB + - [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) — analyse rapide de fichier GPX + - [SortableJS](https://github.com/SortableJS/Sortable) — création d'un arborescence de fichiers triables +- Cartographie: + - [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) — de belles cartes interactives rapides + - [brouter](https://github.com/abrensch/brouter) — moteur de routage + - [OpenStreetMap](https://www.openstreetmap.org) — données cartographiques utilisées par Mapbox et brouter + - [DocSearch](https://github.com/algolia/docsearch) — moteur de recherche de la documentation -## License +## Licence -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +Ce projet est sous licence MIT - voir le fichier [LICENSE](LICENSE) pour plus de détails.