File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -4,6 +4,66 @@ Welcome to lingua-loop's documentation!
44A web application to train your listening skills by transcribing real speech
55from YouTube videos.
66
7+ .. image :: _static/lingua-loop.png
8+ :align: center
9+
10+ Installation
11+ ============
12+
13+ You need Python version 3.12 or higher. It's recommended to create a dedicated
14+ virtual environment first.
15+
16+ Using conda:
17+
18+ .. code-block :: bash
19+
20+ conda create --name lingua-loop python=3.12
21+ conda activate lingua-loop
22+
23+ Using venv on Windows:
24+
25+ .. code-block :: bat
26+
27+ python -m venv .venv_lingua_loop
28+ .\.venv_lingua_loop\Scripts\activate
29+
30+ Using venv on Linux/macOS:
31+
32+ .. code-block :: bash
33+
34+ python -m venv .venv_lingua_loop
35+ . .venv_lingua_loop/bin/activate
36+
37+ Then install the package:
38+
39+ .. code-block :: bash
40+
41+ pip install lingua-loop
42+
43+ The package is also installable directly from the repository:
44+
45+ .. code-block :: bash
46+
47+ pip install git+https://github.com/jfdev001/lingua-loop.git
48+
49+ For a faster install using the ``uv `` package manager:
50+
51+ .. code-block :: bash
52+
53+ uv pip install git+https://github.com/jfdev001/lingua-loop.git
54+
55+ .. note ::
56+ This package is under active development and updated frequently.
57+
58+ Usage
59+ =====
60+
61+ Launch the app (which will open a web browser automatically):
62+
63+ .. code-block :: bash
64+
65+ lingua-loop
66+
767 .. toctree ::
868 :maxdepth: 1
969 :caption: Contents:
You can’t perform that action at this time.
0 commit comments