diff --git a/README.md b/README.md index 0d91c47..b79692c 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,24 @@ To set up a virtual environment for your project and install dependencies, follo ```bash python3.11 -m venv + ``` 3. ** Activate the Virtual Environment:On Windows:** -On Windows: .\\Scripts\activate -On macOS and Linux: source /bin/activate +On Windows: + ```bash + .\\Scripts\activate + ``` +On macOS and Linux: + ```bash + source /bin/activate + ``` Your command prompt should now show the virtual environment name, indicating that it's active. 4. ** Install Dependencies: ** Use pip to install the project's dependencies from the requirements.txt file. Replace with the actual path to your requirements.txt file: -pip install -r + ```bash + pip install -r + ``` This will install all the necessary packages for your project. 5. ** Deactivate the Virtual Environment: ** @@ -31,9 +40,15 @@ Now you have a virtual environment set up for your project with all the required ## Creating Documentation 1. ** Open 'Controls' directory ** -On Linux: $ cd ./memorizer/controls +On Linux: + ```bash + cd ./memorizer/controls + ``` -2. ** Open 'Controls' directory ** -On Linux: $ sphinx-quickstart +2. ** Run the next command ** +On Linux: + ```bash + $ sphinx-quickstart + ``` -3. Follow the instructions \ No newline at end of file +3. Follow the instructions of sphinx \ No newline at end of file