From 92ca8efcff047825062784715924e0b10c0d334a Mon Sep 17 00:00:00 2001 From: DogmaDragon <103123951+DogmaDragon@users.noreply.github.com> Date: Sat, 11 Apr 2026 01:46:39 +0300 Subject: [PATCH] Update local development section and add requirements.txt --- README.md | 15 ++++----------- requirements.txt | 6 ++++++ 2 files changed, 10 insertions(+), 11 deletions(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index a848a36c..f90fa0e1 100644 --- a/README.md +++ b/README.md @@ -18,23 +18,16 @@ Read step-by-step guide on how to create a pull request [CONTRIBUTING.md](CONTRI ### Prerequisites -- Python modules: - - `mkdocs-material=="9.*"` - - `mkdocs-git-revision-date-localized-plugin` - - `mkdocs-git-committers-plugin-2` - - `mkdocs-glightbox` - - `mkdocs-material[imaging]` - - `mkdocs-redirects` - -Install all dependencies with: +- Python 3.10 or higher +- Python modules from [`requirements.txt`](requirements.txt) ```bash -pip install mkdocs-material=="9.*" mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-glightbox "mkdocs-material[imaging]" mkdocs-redirects +pip install -r requirements.txt ``` ### Building the site -1. Open command-line interface and go to your directory where you saved the copy of the repository +1. Clone the repository and navigate to the project directory. 2. Run `mkdocs serve` ## License diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..a9c6b715 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +mkdocs-material==9.* +mkdocs-git-revision-date-localized-plugin +mkdocs-git-committers-plugin-2 +mkdocs-glightbox +mkdocs-material[imaging] +mkdocs-redirects \ No newline at end of file