Skip to content

Commit

Permalink
Update ReadME
Browse files Browse the repository at this point in the history
  • Loading branch information
DoofenCorp committed Aug 13, 2023
1 parent 1f87108 commit 5770d5b
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,23 @@ Keep checking for functionality additions. If any issues are discovered then kin
Current Features:
* Connection with VLC
* Remote commands fully functional
* Speech Recognition implemented in Alpha mode. Lot of improvements and testing needed which would be done in coming days. (13 August 2023). This is a very young alpha release so kindly be patient with it as it may or may not work as expected adhering to the environment (An example is that you may have to speak few times).

* Note: With this Alpha implementation I have removed (not really, just commented it) the previous manual telnet client functionality, this now works entirely on voice commands. If needed you can uncomment line 76 in `connection.py` and remove/comment line 77.

* Tested on Python 3.10 (Should work with Python 3.5+) on Windows 10 Pro 22H2

Upcoming:
* Speech recognition integration for voice control (Probably within this week)
* Improved speech recognition after rigorous testing and possible implementation of offline recognition
* Task scheduling capability integrated into the setup to automatically launch the script with VLC. (Focused for Windows machines)
* ~Speech recognition integration for voice control (Probably within this week)~ Implemented as Alpha on 13 August 2023.
* ~Bug fix for "shutdown" command which works but raises asyncio's runtime error (within couple days)~ Fixed on 23 July 2023.

# SETUP GUIDE:

## 1. Install all requirements:

* Internet connectivity for speech recognition
* Python 3.7+
* `telnetlib3` module
* `SpeechRecognition` module
Expand Down

0 comments on commit 5770d5b

Please sign in to comment.