diff --git a/src/Stratis.VS.StratisEVM/README.html b/src/Stratis.VS.StratisEVM/README.html index 7d8bfdc..cc2ad8c 100644 --- a/src/Stratis.VS.StratisEVM/README.html +++ b/src/Stratis.VS.StratisEVM/README.html @@ -1,30 +1,37 @@  -

About

-

The StratisEVM extension provides support for developing Stratis Solidity smart contracts inside Visual Studio.

-

Features

- -

Requirements

- -

Usage

-

- Use the Visual Studio Open Folder... feature to open a folder with Solidity contracts. Edit a Solidity file as normal. To compile a Solidity file, right-click - on the file in Solution Explorer and select 'Compile Solidity File'. -

-

- The first time you open a folder with Solidity contracts the extension will install the necessary Node.js modules in the extension's private node_modules directory. - This will take a few seconds to complete so opening the folder will be slower than normal but after the modules are installed the first time, opening folders containing - Solidity contracts will be as usual. -

+

About

+

The StratisEVM extension provides support for developing Stratis Solidity smart contracts inside Visual Studio.

+

Features

+ +

Requirements

+ +

Usage

+

Use the Visual Studio Open Folder... feature to open a folder with Solidity contracts. Your folder should contain one of the following files:

+ +

which indicates it is a Solidity project folder. (This is needed for things like error-checking as-you-type by the Solidity compiler.)

+

Edit a Solidity file as normal. To compile a Solidity file, right-click on the file in Solution Explorer and select 'Compile Solidity File'.

+

+ The first time you open a folder with Solidity contracts the extension will install the necessary Node.js modules in the extension's private node_modules directory. + This will take a few seconds to complete so opening the folder will be slower than normal but after the modules are installed the first time, opening folders containing + Solidity contracts will be as usual. +

\ No newline at end of file diff --git a/src/Stratis.VS.StratisEVM/README.md b/src/Stratis.VS.StratisEVM/README.md index e0a37e9..a353e3b 100644 --- a/src/Stratis.VS.StratisEVM/README.md +++ b/src/Stratis.VS.StratisEVM/README.md @@ -7,15 +7,24 @@ The StratisEVM extension provides support for developing Stratis Solidity smart * Syntax highlighting and hover information * Intellisense * Linting -* Compiling a Solidity file from inside Visual Studio +* Compile a Solidity file from inside Visual Studio ## Requirements * Visual Studio 2022 * A recent version of [Node.js](https://nodejs.org/) ## Usage -Use the Visual Studio Open Folder... feature to open a folder with Solidity contracts. Edit a Solidity file as normal. To compile a Solidity file, right-click -on the file in Solution Explorer and select 'Compile Solidity File'. +Use the Visual Studio Open Folder... feature to open a folder with Solidity contracts. Your folder should contain one of the following files: +* remappings.txt +* foundry.toml +* brownie-config.yaml +* truffle-config.js +* hardhat.config.js +* hardhat.config.ts + +which indicates it is a Solidity project folder. (This is needed for things like error-checking as-you-type by the Solidity compiler.) + +Edit a Solidity file as normal. To compile a Solidity file, right-click on the file in Solution Explorer and select 'Compile Solidity File'. The first time you open a folder with Solidity contracts the extension will install the necessary Node.js modules in the extension's private `node_modules` directory. This will take a few seconds to complete so opening the folder will be slower than normal but after the modules are installed the first time, opening folders containing diff --git a/src/Stratis.VS.StratisEVM/source.extension.vsixmanifest b/src/Stratis.VS.StratisEVM/source.extension.vsixmanifest index 3b8bd53..52b6e7f 100644 --- a/src/Stratis.VS.StratisEVM/source.extension.vsixmanifest +++ b/src/Stratis.VS.StratisEVM/source.extension.vsixmanifest @@ -1,7 +1,7 @@ - + StratisEVM StratisEVM smart contracts extension https://github.com/stratisdevex/Stratis.DevEx/tree/master/src/Stratis.VS.StratisEVM