Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bruhnild authored and dtrucs committed Oct 14, 2024
1 parent b841c0a commit 9094631
Showing 1 changed file with 33 additions and 13 deletions.
46 changes: 33 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,47 @@ The third version is a full redesign and rewriting of Geotrek-rando with React,

Geotrek-rando v3 is directly connected to Geotrek-admin v2 API.

Read more in the [general presentation](./docs/presentation-fr.md).
## 💡 Présentation (french)

## Documentation for administrators
Read more in the [general presentation](https://geotrek-rando-v3.readthedocs.io/latest/presentation-fr/).

- [Installation for production](./docs/installation.md)
- [Customization](./docs/customization.md)
## 🚀 Installation

## Documentation for developers
- [Production installation](https://geotrek-rando-v3.readthedocs.io/latest/installation/)

- [Installation on a dev machine](./docs/development.md)
- [Deployment](./docs/deployment.md)
## 🎨 Customization

## Getting started
- [Introduction](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-introduction/)
- [Settings](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-settings/)
- [Theme and style](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-themestyles/)
- [Icons](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-icons/)
- [Translation](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-translation/)
- [HTML and scripts](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-htmlscripts/)
- [GDPR](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-gdpr/)
- [Media management](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-mediamanagement/)

- Follow the [development](./docs/development.md) docs
- Head to [localhost:3000](http://localhost:3000)
## 🔧 Development

- [Development installation](https://geotrek-rando-v3.readthedocs.io/latest/development/development/)
- [Deployment](https://geotrek-rando-v3.readthedocs.io/latest/development/deployment/)
- [Contributing](https://geotrek-rando-v3.readthedocs.io/latest/development/contributing/)

## ✨ Knowledge

- [Caching strategies](https://geotrek-rando-v3.readthedocs.io/latest/knowledge/caching/)
- [Debug mode](https://geotrek-rando-v3.readthedocs.io/latest/knowledge/debug/)
- [Pages and navigation](https://geotrek-rando-v3.readthedocs.io/latest/knowledge/pages-and-navigation/)
- [Server side rendering](https://geotrek-rando-v3.readthedocs.io/latest/knowledge/server-side-rendering/)

## Architecture decision records
## 🧱 Architecture decision record

- [Main framework](./docs/adrs/main_framework.md)
- [Deployment solution](./docs/adrs/deployment_solution.md)
- [Main framework](https://geotrek-rando-v3.readthedocs.io/latest/adrs/main_framework/)
- [Deployment solution](https://geotrek-rando-v3.readthedocs.io/latest/adrs/deployment_solution/)

## 🪄 Getting started

- Follow the [development](https://geotrek-rando-v3.readthedocs.io/latest/development/development/) docs
- Head to [localhost:3000](http://localhost:3000)

<a href="https://territoires.makina-corpus.com/"><img src="https://geotrek.fr/assets/img/logo_makina.svg" alt="Logo MCT" width="115"></a>
[![](https://geotrek.fr/assets/img/logo_autonomens-h120m.png)](https://datatheca.com/)

0 comments on commit 9094631

Please sign in to comment.