temp readme commit

Author: mpourmpoulis

README.md

@@ -1,20 +1,48 @@
-This is the sublime portion of 
+# LSP-pyvoice
+
+This is the sublime portion of [pyvoice](https://github.com/PythonVoiceCodingPlugin/pyvoice)
+
+
+<div>
+<img src="https://github.com/PythonVoiceCodingPlugin/assets/blob/main/pyvoice_logo.png" align="right" height=320 width=320/>
+</div>
+
 <!-- MarkdownTOC  autolink="true" -->
 
+- [Features](#features)
 - [Installation](#installation)
+	- [Pre-requisites](#pre-requisites)
 	- [Install the plugin](#install-the-plugin)
 	- [Install the grammar](#install-the-grammar)
 - [Settings](#settings)
+	- [Default settings](#default-settings)
+	- [Editing settings globally](#editing-settings-globally)
+	- [Editing settings per project](#editing-settings-per-project)
 - [Enabling or Disabling the plugin](#enabling-or-disabling-the-plugin)
 - [Commands](#commands)
+- [Viewing Logs](#viewing-logs)
+	- [Event Listener logs](#event-listener-logs)
+	- [LSP traffic](#lsp-traffic)
+	- [Server logs](#server-logs)
+- [Licensing And Acknowledgements](#licensing-and-acknowledgements)
 
 <!-- /MarkdownTOC -->
 
-https://github.com/PythonVoiceCodingPlugin/pyvoice
+# Features
+
+It is implemented as an [LSP](https://packagecontrol.io/packages/LSP) package and provides the following functionality
+
+- it automatically manages installing and updating the [pyvoice](https://github.com/PythonVoiceCodingPlugin/pyvoice) for you in its own seperate virtual environment
+
+- it provides the customizations to the sublime  LSP client, needed for receiving speech hints, etc from the language server
+
+- it manages the communication with the programming by voice framework
 
 # Installation
 
-## Install the plugin
+## Pre-requisites
+
+- Make sure you have some version of [Python](https://www.python.org/downloads/) >= 3.8 installed on your system. This is needed for installing and running the pyvoice executable
 
 - Make sure you have [Package Control](https://packagecontrol.io/installation) installed in Sublime Text.
 
@@ -23,12 +51,14 @@ https://github.com/PythonVoiceCodingPlugin/pyvoice
 	- run `Package Control: Install Package`
 	- search for `LSP` and install it
 
-- Finally, install this package via Package Control using a custom repository
+## Install the plugin
+
+Finally, install this package via Package Control using a custom repository
 	- Open the command palette `ctrl+shift+p` or `cmd+shift+p`
 	- run `Package Control: Add Repository`
 	- paste the url of this repository: `https://github.com/PythonVoiceCodingPlugin/LSP-pyvoice`
 
-- Restart Sublime Text and navigate to any python file, you should see these in the sidebar
+Restart Sublime Text and navigate to any python file, you should see these in the sidebar
 
 ## Install the grammar
 
@@ -38,12 +68,105 @@ https://github.com/PythonVoiceCodingPlugin/pyvoice
 
 # Settings
 
+The project builts on top of the standard [LSP client configuration](https://lsp.sublimetext.io/client_configuration/) 
+
+## Default settings
+
+```json
+{
+    "command": [
+        "$server_path"
+    ],
+    "python_binary": null,
+    "env": {},
+    "settings": {
+        // The base path where your python project is located.
+        // Like all paths in this settings file it can be either
+        // absolute or relative to the path of the sublime project.
+        "project.path": ".",
+        
+        // The path to the root of the virtual environemnt
+        // again either absolute or relative to the sublime project path.
+        "project.environmentPath": ".venv",
+        
+        // A list of paths to override the sys path if needed.
+        // WARNING: This will COMPLETELY override the sys.path.
+        // Leave this null,to generate sys.path from the environment.
+        "project.sysPath": null,
+        
+        // Adds these paths at the end of the sys path.
+        "project.addedSysPath": [],
+        
+        // If enabled (default), adds paths from local directories.
+        // Otherwise, you will have to rely on your packages being properly configured on the sys.path.
+        "project.smartSysPath": true,
+        
+    },
+
+    "selector": "source.python",
+    // ST3
+    "languages": [
+        {
+            "languageId": "python",
+            "scopes": [
+                "source.python"
+            ],
+            "syntaxes": [
+                "Packages/Python/Python.sublime-syntax"
+            ],
+        }
+    ],
+}
+```
+
+The main settings are
+
+- `command` : the command to launch the language server. Change this if you do not want to use the pyvoice executable that gets automatically installed
+
+- `python_binary` : the python binary to use for launching the language server. If not set, it defaults to 
+the python binary that is in the system PATH
+
+- `env` : the environment variables to use when launching the language server. If not set, it defaults to the current environment variables
+
+- `settings` : the settings to pass to the language server. 
+	- `venvPath` which is the path to the virtual environment for your project. If not set, it defaults to `.venv`
+	- `ext`
+
+
+
+## Editing settings globally
+
 To edit the global settings click in the menu
 
 `Preferences > Package Settings > LSP > Servers > LSP-pyvoice`
 
 Or from the command palette `ctrl+shift+p` or `cmd+shift+p` run `Preferences: LSP-pyvoice Settings`
 
+## Editing settings per project
+
+To edit the settings for a specific project, click in the menu
+
+`Project > Edit Project`
+
+and add the following settings
+
+```json
+{
+	"settings":
+	{
+		"LSP":
+		{
+			"LSP-pyvoice":
+			{
+				// your customizations go in here
+			},
+		},
+
+	},
+}
+```
+
+
 # Enabling or Disabling the plugin
 
 The plugin is enabled by default. To disable it, open the command palette `ctrl+shift+p` or `cmd+shift+p` and run `LSP: Disable Language Server Globally`. Then choose `LSP-pyvoice` from the list of language servers. To enable it again, run `LSP: Enable Language Server Globally`.
@@ -62,3 +185,18 @@ The following commands are available in the command palette `ctrl+shift+p` or `c
 
 - `Preferences: LSP-pyvoice Settings`
 - `LSP-pyvoice: Get Spoken` it allows you to manually trigger fetching spoken  information from the server
+
+
+# Viewing Logs
+
+## Event Listener logs
+## LSP traffic
+## Server logs
+
+
+
+# Licensing And Acknowledgements
+
+
+[LSP-pylsp](https://github.com/sublimelsp/LSP-pylsp)
+[SublimeTalon](https://github.com/trishume/SublimeTalon/blob/master/sublime_talon.py)