Skip to content

Commit

Permalink
somehow readme didn't come over. Super weird
Browse files Browse the repository at this point in the history
  • Loading branch information
tomlm committed Dec 7, 2024
1 parent d6b99e8 commit 78e6d52
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions src/Experimental/Avalonia.PreviewHost/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Consolonia.PreviewHost
This is a tool which enables a live view of a consolonia axaml file, or a consolonia project.

## Installation
To install the tool, you can use the following command:
```
dotnet tool install -g Consolonia.PreviewHost
```

## Usage
To use the tool, you can use the following command:
```
Consolonia.PreviewHost <path-to-axaml-file>|<path-to-project-file>|<path-to-project-directory>
```

It will monitor the file or directory for changes, and will automatically update the preview when changes are detected.

Run the following command to monitor the project or folder:

``` Conoslonia.PreviewHost <path-to-project-file-or-folder> ```

Run following command to monitor a given .axaml file.

``` Conoslonia.PreviewHost <.axaml file name> ```

> NOTE: In single file mode the tool will exit when you hit escape key
### Running inside Visual Studio
1. Open the solution in Visual Studio.
1. Open a Terminal (View -> Terminal).
3. run the following command
``` Consolonia.PreviewHost . ```

### Running inside Visual Studio Code
To integrate the tool with Visual Studio Code, you can use the following steps:
1. Open the project directory in Visual Studio Code.
2. Open a terminal inside of visual studio code
3. run the following command
``` Consolonia.PreviewHost . ```

0 comments on commit 78e6d52

Please sign in to comment.