From 72b0796925dd19939db97155c6718fb4cdabf0f3 Mon Sep 17 00:00:00 2001 From: "alexandre.caldato" <alexandre.caldato@sully-group.fr> Date: Thu, 1 Jun 2023 18:58:42 +0200 Subject: [PATCH] add readme --- .idea/.gitignore | 8 ++++++++ README.md | 17 +++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .idea/.gitignore diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/README.md b/README.md index e69de29..000ea34 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. -- GitLab