From d979c711d6daf2a6220c25d32639c05b799caea8 Mon Sep 17 00:00:00 2001 From: Benjamin Loison Date: Thu, 23 Feb 2023 23:48:40 +0100 Subject: [PATCH] Precise in `README.md` in which folder each command has to be ran --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 5f3391c..59db7b4 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,18 @@ See more details on [the Wiki](https://gitea.lemnoslife.com/Benjamin_Loison/YouT Because of [the current compression mechanism](https://gitea.lemnoslife.com/Benjamin_Loison/YouTube_captions_search_engine/issues/30), Linux is the only known OS able to run this algorithm. +To clone the repository, run: + +```sh +git clone https://gitea.lemnoslife.com/Benjamin_Loison/YouTube_captions_search_engine +``` + +Move to the cloned repository by running: + +```sh +cd YouTube_captions_search_engine/ +``` + To install the dependencies on an `apt` based Linux distribution of this project make sure to have [`pip`](https://pip.pypa.io/en/stable/installation/) and run: ```sh @@ -44,6 +56,12 @@ Except if you provide the argument `--no-keys`, you have to provide at least one # Hosting the website enabling users to make requests: +Move to the `website/` folder by running: + +```sh +cd website/ +``` + To install its dependencies make sure to have [`composer`](https://getcomposer.org/doc/00-intro.md) installed and run: ```sh