Skip to content

Commit

Permalink
Add a readme for the documentaion start.
Browse files Browse the repository at this point in the history
  • Loading branch information
Motouom committed Nov 18, 2024
1 parent 1287df4 commit 44c6b31
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]
```

- 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
```

0 comments on commit 44c6b31

Please sign in to comment.