diff --git a/README.md b/README.md index 37a2f8e91..aa0a5b4e3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,34 @@ -# kc-config-cli +# Set-up to install and get start with documentation in Keycloak config cli +- Make sure to have python installed. +On MAC +``` +sudo apt install python3.8 +``` +On Ubuntu +```Bash +brew install python@3.8 +``` + +- Create the virtual environment in the root directory of your project. +```Bash +python3 -m venv venv +``` + +- Activate the virtual environment +```Bash +source venv/bin/activate +``` + +- install the requirements needed +``` +pip install mkdocs-material +pip install "mkdocs-material[imaging]" +``` + +- Start the documentation. +```Bash +mkdocs serve +``` \ No newline at end of file