From ba9e42b9c6f15b5a237a2bd824c2bdc4bbe74ace Mon Sep 17 00:00:00 2001 From: paprykdev <58005447+paprykdev@users.noreply.github.com> Date: Fri, 15 Nov 2024 22:40:07 +0100 Subject: [PATCH] docs: update README to correct script paths and improve instructions --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 28a5d7d..8952594 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This project is a web scraper designed to extract data from websites. 1. Clone the repository: ```bash -git clone https://git.wmi.amu.edu.pl/s500042/webscraper +git clone https://git.wmi.amu.edu.pl/s500042/webscraper ``` 2. Navigate to the project directory: @@ -27,44 +27,48 @@ cd webscraper 3. Build the Docker image and run it using `start.py` script: ```bash -python start.py +python scripts/start.py ``` On Mac, you'll have to use ```bash -python3 start.py +python3 scripts/start.py ``` +4. Check `/app/dist/data.json` file to see the extracted data. + ### Without Docker 1. Clone the repository: ```bash -git clone https://github.com/yourusername/webscraper.git +git clone https://git.wmi.amu.edu.pl/s500042/webscraper ``` 2. Install the required dependencies: ```bash -pip install -r requirements.txt +pip install -r app/requirements.txt ``` If you're on Arch Linux, you'll need to create a virtual environment. Here's is a [Step by step guide](#) that will help you create it. -3. Run `run-with-no-docker.py` script: +3. Run `run_with_no_docker.py` script: ```bash -python run-with-no-docker.py +python scripts/run_with_no_docker.py ``` On Mac you'll, need to use: ```bash -python3 run-with-no-dcoker.py +python3 scripts/run_with_no_docker.py ``` +4. Check `/app/dist/data.json` file to see the extracted data. + ## License This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.