Ajout d'un readme

README.md

@@ -1,3 +1,77 @@
-# reel-caption-maker
+# Reel Caption Maker
 
-Outil pour ajouter des captions sur des reels Instagram
+Reel Caption Maker is a tool for adding captions to Instagram reels. This guide will help you set up and run the application, even if you're not a developer.
+
+## Prerequisites
+
+Before you begin, make sure you have the following installed on your computer:
+
+1. Python 3.8 or newer: Download from [python.org](https://www.python.org/downloads/)
+2. Git: Download from [git-scm.com](https://git-scm.com/downloads)
+
+## Installation Steps
+
+1. Open your computer's terminal or command prompt.
+
+2. Clone the repository:# reel-caption-maker
+
+```
+git clone https://github.com/yourusername/reel-caption-maker.git
+cd reel-caption-maker
+```
+
+3. Create a virtual environment:
+- On Windows:
+  ```
+  python -m venv venv
+  venv\Scripts\activate
+  ```
+- On macOS and Linux:
+  ```
+  python3 -m venv venv
+  source venv/bin/activate
+  ```
+
+4. Install the required packages:
+
+```
+pip install -r requirements.txt
+```
+
+## Running the Application
+
+1. Make sure you're in the project directory and your virtual environment is activated.
+
+2. Start the Streamlit app:
+
+```
+streamlit run app.py
+```
+
+3. Your default web browser should open automatically. If it doesn't, copy the URL shown in the terminal (usually http://localhost:8501) and paste it into your browser.
+
+## Using Reel Caption Maker
+
+1. Click "Browse files" to upload your video.
+2. Select the video language (French or English).
+3. Click "Generate Captions" to transcribe the audio.
+4. Edit the generated captions if needed.
+5. Click "Burn Captions and Download" to add the captions to your video and download it.
+
+## Troubleshooting
+
+- If you encounter any errors, make sure you've followed all the steps correctly.
+- Ensure that your virtual environment is activated when running the application.
+- If you're still having issues, try closing the terminal, reopening it, and starting from step 3 of the Installation Steps.
+
+## Closing the Application
+
+To stop the application, press Ctrl+C in the terminal where the app is running.
+
+Remember to deactivate the virtual environment when you're done:
+
+```
+deactivate
+```
+
+Enjoy using Reel Caption Maker!