usfmEditor README

This is the README for the extension "usfmeditor". Todo is to write a brief description and then to list the following features..

Features

Describe specific features of this extension including screenshots of this extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under this extension project workspace:


Tip: Many popular extensions utilize animations. This is an excellent way to show off this extension! We recommend short, focused animations that are easy to follow.

Running Extension in VsCode

Open a terminal window and run:

node --version

Or for MacOS do:

/usr/local/bin/node --version

Make sure that node was found and that it is v18 or greater. Install node if not found, or upgrade it. Then rerun the version checking steps.

Then enter and run this command to install dependencies:

npm run install:all

Then build the app by running this command:

npm run build:webview

Or if you are doing development and want it to recompile on every code change run this command:

npm run build:webview

When compile is done, hit the F5 key which opens another instance of VS Code in debug mode.

Then in the vsCode, do file => open folder and navigate to a folder which has your target language USFM files. In the file navigation on the left, select a USFM file. Then go down to the lower left and expand the USFM Outline. Select a specifc chapter and verse. You will then see two icons to the right of your selection - the first in the alignment tool and the second is the edit tool.

Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.

Extension Settings

Include if this extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

• myExtension.enable: Enable/disable this extension.
• myExtension.thing: Set to blah to do something.

Known Issues

Calling out known issues can help limit users opening duplicate issues against this extension.

Release Notes

Users appreciate release notes as you update this extension.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.

---

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating this extension.

• Extension Guidelines

Working with Markdown

You can author this README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference