Merge pull request #14 from bendsouza2/enhancement/readme-general

Enhancement/readme general

README.md

@@ -1,5 +1,10 @@
 # YT-Translator
 
+### Project Overview
+The aim of this project is to provide language learning resources. The project was developed with Spanish as the target language to learn and English as the base language. However this can easily be changed in the project configuration to provide language learning resources for other languages. See project setup for details.
+
+The project is currently still in development and is not yet in mainenance mode.
+
 ### Setup
 1. Install the requirements to your venv `pip install -r requirements.txt`
 2. To be able to import enchant in python we'll need to install the Enchant C library (on Mac)
@@ -8,5 +13,9 @@
 	 	* `export DYLD_LIBRARY_PATH="<PATH_TO_ENCHANT_INSTALL>:$DYLD_LIBRARY_PATH"`
 	 	* `export ENCHANT_LIBRARY_PATH="<PATH_TO_ENCHANT_INSTALL>"`
 3. Configure environment variables:
-	* OPENAI_API_KEY = <YOUR_API_KEY>
+	* `OPENAI_API_KEY = <YOUR_API_KEY>`
+4. Run `npm install` to install the Node.js dependencies (echogarden)
+5. In the constants.py file:
+	* Set the LANGUAGE_TO_LEARN variable to the language you want to publish language learning videos for: e.g. `LANGUAGE_TO_LEARN = "es`
+	* Set the NATIVE_LANGUAGE variable to the language which should be used as a base language to learn the secondary language from: e.g. `NATIVE_LANGUAGE = "en"`
 

python/word_generator.py

@@ -34,7 +34,6 @@ def lexical_test_real_word(self, word: str) -> bool:
         """
         Test if a word is genuine by checking it is in the dictionary
         :param word: The word to test
-        :param language_code: The language the word should exist in
         :return True if the word exists in the dictionary, else False
         """
 
@@ -86,7 +85,7 @@ def __init__(
             s3_file_path: Optional[str] = None,
     ):
         """
-        Iniatalise an object of the ImageGenerator class
+        Initialise an object of the ImageGenerator class
         :param prompts: The prompts to use to create the image
         :param local_image_storage: Optional. Whether to store the image locally or remotely. Defaults to True
         :param local_file_path: Optional. The file path if storing the file locally
@@ -151,7 +150,7 @@ def __init__(self,
                  native_language: str,
                  ):
         """
-        Initalise an Audio object
+        Initialise an Audio object
         :param word_list_path: The file path to the list of words.
         :param language_to_learn: The language the user is learning.
         :param native_language: The native language of the user.