Skip to content

Commit d72ce02

Browse files
committed
Arrange the Getting Started section
1 parent adbf4ee commit d72ce02

File tree

1 file changed

+106
-106
lines changed

1 file changed

+106
-106
lines changed

README.md

Lines changed: 106 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@
8383
- [Project Structure](#project-structure)
8484
- [Built With](#built-with)
8585
- [Getting Started](#getting-started)
86-
- [Notes](#notes)
87-
- [To Run the Program](#to-run-the-program)
86+
- [Installation](#installation)
8887
- [To Set Up the Project Locally](#to-set-up-the-project-locally)
88+
- [Notes](#notes)
8989
- [Usage](#usage)
9090
- [Transcribe From](#transcribe-from)
9191
- [Save Transcription](#save-transcription)
@@ -304,49 +304,45 @@ You can also choose the theme you like best. It can be dark, light, or the one c
304304

305305
## Getting Started
306306

307-
### Notes
308-
- You cannot generate a single executable file for this project with PyInstaller due to the dependency with the CustomTkinter package (reason [here](https://github.com/TomSchimansky/CustomTkinter/wiki/Packaging)).
309-
- For **Mac computers with Apple silicon**: An error occurs when trying to install the `pyaudio` package. [Here](https://stackoverflow.com/questions/73268630/error-could-not-build-wheels-for-pyaudio-which-is-required-to-install-pyprojec) is a StackOverflow post explaining how to solve this issue.
310-
- You need to install [FFmpeg](https://ffmpeg.org) to execute the program. Otherwise, it won't be able to process the audio files.
311-
312-
To check if you have it installed on your system, run `ffmpeg -version`. It should return something similar to this:
313-
```
314-
ffmpeg version 5.1.2-essentials_build-www.gyan.dev Copyright (c) 2000-2022 the FFmpeg developers
315-
built with gcc 12.1.0 (Rev2, Built by MSYS2 project)
316-
configuration: --enable-gpl --enable-version3 --enable-static --disable-w32threads --disable-autodetect --enable-fontconfig --enable-iconv --enable-gnutls --enable-libxml2 --enable-gmp --enable-lzma --enable-zlib --enable-libsrt --enable-libssh --enable-libzmq --enable-avisynth --enable-sdl2 --enable-libwebp --enable-libx264 --enable-libx265 --enable-libxvid --enable-libaom --enable-libopenjpeg --enable-libvpx --enable-libass --enable-libfreetype --enable-libfribidi --enable-libvidstab --enable-libvmaf --enable-libzimg --enable-amf --enable-cuda-llvm --enable-cuvid --enable-ffnvcodec --enable-nvdec --enable-nvenc --enable-d3d11va --enable-dxva2 --enable-libmfx --enable-libgme --enable-libopenmpt --enable-libopencore-amrwb --enable-libmp3lame --enable-libtheora --enable-libvo-amrwbenc --enable-libgsm --enable-libopencore-amrnb --enable-libopus --enable-libspeex --enable-libvorbis --enable-librubberband
317-
libavutil 57. 28.100 / 57. 28.100
318-
libavcodec 59. 37.100 / 59. 37.100
319-
libavformat 59. 27.100 / 59. 27.100
320-
libavdevice 59. 7.100 / 59. 7.100
321-
libavfilter 8. 44.100 / 8. 44.100
322-
libswscale 6. 7.100 / 6. 7.100
323-
libswresample 4. 7.100 / 4. 7.100
324-
```
325-
326-
If the output is an error, it is because your system cannot find the `ffmpeg` system variable, which is probably because you don't have it installed on your system. To install `ffmpeg`, open a command prompt and run one of the following commands, depending on your operating system:
327-
```
328-
# on Ubuntu or Debian
329-
sudo apt update && sudo apt install ffmpeg
330-
331-
# on Arch Linux
332-
sudo pacman -S ffmpeg
333-
334-
# on MacOS using Homebrew (https://brew.sh/)
335-
brew install ffmpeg
336-
337-
# on Windows using Chocolatey (https://chocolatey.org/)
338-
choco install ffmpeg
339-
340-
# on Windows using Scoop (https://scoop.sh/)
341-
scoop install ffmpeg
342-
```
343-
344-
### To Run the Program
345-
1. Go to [releases](https://github.com/HenestrosaDev/audiotext/releases).
346-
2. Download the latest release.
307+
### Installation
308+
309+
1. Install [FFmpeg](https://ffmpeg.org) to execute the program. Otherwise, it won't be able to process the audio files.
310+
311+
To check if you have it installed on your system, run `ffmpeg -version`. It should return something similar to this:
312+
```
313+
ffmpeg version 5.1.2-essentials_build-www.gyan.dev Copyright (c) 2000-2022 the FFmpeg developers
314+
built with gcc 12.1.0 (Rev2, Built by MSYS2 project)
315+
configuration: --enable-gpl --enable-version3 --enable-static --disable-w32threads --disable-autodetect --enable-fontconfig --enable-iconv --enable-gnutls --enable-libxml2 --enable-gmp --enable-lzma --enable-zlib --enable-libsrt --enable-libssh --enable-libzmq --enable-avisynth --enable-sdl2 --enable-libwebp --enable-libx264 --enable-libx265 --enable-libxvid --enable-libaom --enable-libopenjpeg --enable-libvpx --enable-libass --enable-libfreetype --enable-libfribidi --enable-libvidstab --enable-libvmaf --enable-libzimg --enable-amf --enable-cuda-llvm --enable-cuvid --enable-ffnvcodec --enable-nvdec --enable-nvenc --enable-d3d11va --enable-dxva2 --enable-libmfx --enable-libgme --enable-libopenmpt --enable-libopencore-amrwb --enable-libmp3lame --enable-libtheora --enable-libvo-amrwbenc --enable-libgsm --enable-libopencore-amrnb --enable-libopus --enable-libspeex --enable-libvorbis --enable-librubberband
316+
libavutil 57. 28.100 / 57. 28.100
317+
libavcodec 59. 37.100 / 59. 37.100
318+
libavformat 59. 27.100 / 59. 27.100
319+
libavdevice 59. 7.100 / 59. 7.100
320+
libavfilter 8. 44.100 / 8. 44.100
321+
libswscale 6. 7.100 / 6. 7.100
322+
libswresample 4. 7.100 / 4. 7.100
323+
```
324+
325+
If the output is an error, it is because your system cannot find the `ffmpeg` system variable, which is probably because you don't have it installed on your system. To install `ffmpeg`, open a command prompt and run one of the following commands, depending on your operating system:
326+
```
327+
# on Ubuntu or Debian
328+
sudo apt update && sudo apt install ffmpeg
329+
330+
# on Arch Linux
331+
sudo pacman -S ffmpeg
332+
333+
# on MacOS using Homebrew (https://brew.sh/)
334+
brew install ffmpeg
335+
336+
# on Windows using Chocolatey (https://chocolatey.org/)
337+
choco install ffmpeg
338+
339+
# on Windows using Scoop (https://scoop.sh/)
340+
scoop install ffmpeg
341+
```
342+
343+
2. Go to [releases](https://github.com/HenestrosaDev/audiotext/releases) and download the latest.
347344
3. Decompress the downloaded file.
348-
4. Open the `audiotext` folder.
349-
5. Double-click the `Audiotext` executable file (`.exe` for Windows and `.app` for macOS).
345+
4. Open the `audiotext` folder and double-click the `Audiotext` executable file (`.exe` for Windows and `.app` for macOS).
350346
351347
### To Set Up the Project Locally
352348
1. Clone the repository by running `git clone https://github.com/HenestrosaDev/audiotext.git`.
@@ -365,6 +361,10 @@ You can also choose the theme you like best. It can be dark, light, or the one c
365361

366362
>**IMPORTANT NOTE**: I had to comment out the lines `pprint(response_text, indent=4)` in the `recognize_google` function from the `__init__.py` file of the `SpeechRecognition` package to avoid opening a command line along with the GUI. Otherwise, the program would not be able to use the Google API transcription method because `pprint` throws an error if it cannot print to the CLI, preventing the code from generating the transcription. The same applies to the lines using the `logger` package in the `moviepy/audio/io/ffmpeg_audiowriter` file from the `moviepy` package. There is also a change in the line 169. `logger=logger` has been changed to `logger=None` to avoid more errors related to opening the console.
367363
364+
### Notes
365+
- You cannot generate a single executable file for this project with PyInstaller due to the dependency with the CustomTkinter package (reason [here](https://github.com/TomSchimansky/CustomTkinter/wiki/Packaging)).
366+
- For **Mac computers with Apple silicon**: An error occurs when trying to install the `pyaudio` package. [Here](https://stackoverflow.com/questions/73268630/error-could-not-build-wheels-for-pyaudio-which-is-required-to-install-pyprojec) is a StackOverflow post explaining how to solve this issue.
367+
368368
<p align="right">(<a href="#top">back to top</a>)</p>
369369

370370
<!-- USAGE -->
@@ -394,76 +394,76 @@ You can transcribe from three audio sources:
394394

395395
- **File** (see image above): Click on the file explorer icon to select the file you want to transcribe. You can also manually enter the path to the file into the input field. You can transcribe audio from both audio and video files. Note that the file explorer has the `All supported files` option selected by default. To select only audio files or video files, click the combo box in the lower right corner of the file explorer to change the file type, as marked in red in the following image:
396396

397-
![File explorer](docs/file-explorer.png)
398-
399-
![Supported files](docs/supported-files.png)
400-
401-
<details>
402-
<summary>Supported audio file formats</summary>
403-
404-
- `.mp3`
405-
- `.mpeg`
406-
- `.wav`
407-
- `.wma`
408-
- `.aac`
409-
- `.flac`
410-
- `.ogg`
411-
- `.oga`
412-
- `.opus`
413-
</details>
414-
415-
<details>
416-
<summary>Supported video file formats</summary>
417-
418-
- `.mp4`
419-
- `.m4a`
420-
- `.m4v`
421-
- `.f4v`
422-
- `.f4a`
423-
- `.m4b`
424-
- `.m4r`
425-
- `.f4b`
426-
- `.mov`
427-
- `.avi`
428-
- `.webm`
429-
- `.flv`
430-
- `.mkv`
431-
- `.3gp`
432-
- `.3gp2`
433-
- `.3g2`
434-
- `.3gpp`
435-
- `.3gpp2`
436-
- `.ogv`
437-
- `.ogx`
438-
- `.wmv`
439-
- `.asf`
440-
</details>
397+
![File explorer](docs/file-explorer.png)
398+
399+
![Supported files](docs/supported-files.png)
400+
401+
<details>
402+
<summary>Supported audio file formats</summary>
403+
404+
- `.mp3`
405+
- `.mpeg`
406+
- `.wav`
407+
- `.wma`
408+
- `.aac`
409+
- `.flac`
410+
- `.ogg`
411+
- `.oga`
412+
- `.opus`
413+
</details>
414+
415+
<details>
416+
<summary>Supported video file formats</summary>
417+
418+
- `.mp4`
419+
- `.m4a`
420+
- `.m4v`
421+
- `.f4v`
422+
- `.f4a`
423+
- `.m4b`
424+
- `.m4r`
425+
- `.f4b`
426+
- `.mov`
427+
- `.avi`
428+
- `.webm`
429+
- `.flv`
430+
- `.mkv`
431+
- `.3gp`
432+
- `.3gp2`
433+
- `.3g2`
434+
- `.3gpp`
435+
- `.3gpp2`
436+
- `.ogv`
437+
- `.ogx`
438+
- `.wmv`
439+
- `.asf`
440+
</details>
441441

442442
- **Microphone**: To start recording, simply click the `Start recording` button to begin the process. The text of the button will change to `Stop recording` and its color will change to red. Click it to stop recording and generate the transcription.
443443

444-
Note that your operating system must recognize an input source, otherwise an error will appear in the text box indicating that no input source was detected.
444+
Note that your operating system must recognize an input source, otherwise an error will appear in the text box indicating that no input source was detected.
445445

446-
Here is a video demonstrating this feature:
446+
Here is a video demonstrating this feature:
447447

448-
<!-- english.mp4 -->
449-
https://github.com/HenestrosaDev/audiotext/assets/60482743/bd0323d7-ff54-4363-8b73-a2d56e7f783b
448+
<!-- english.mp4 -->
449+
https://github.com/HenestrosaDev/audiotext/assets/60482743/bd0323d7-ff54-4363-8b73-a2d56e7f783b
450450

451451
- **YouTube video**: Enter the video URL in the upper input field. When finished, click on the `Generate transcription` button.
452452

453-
<picture>
454-
<source
455-
srcset="docs/light/from-youtube.png"
456-
media="(prefers-color-scheme: light)"
457-
/>
458-
<source
459-
srcset="docs/dark/from-youtube.png"
460-
media="(prefers-color-scheme: dark)"
461-
/>
462-
<img
463-
src="docs/light/from-youtube.png"
464-
alt="From microphone"
465-
>
466-
</picture>
453+
<picture>
454+
<source
455+
srcset="docs/light/from-youtube.png"
456+
media="(prefers-color-scheme: light)"
457+
/>
458+
<source
459+
srcset="docs/dark/from-youtube.png"
460+
media="(prefers-color-scheme: dark)"
461+
/>
462+
<img
463+
src="docs/light/from-youtube.png"
464+
alt="From microphone"
465+
>
466+
</picture>
467467
468468
### Save Transcription
469469

0 commit comments

Comments
 (0)