Skip to content

Commit

Permalink
Update READMEs. Bump version.
Browse files Browse the repository at this point in the history
  • Loading branch information
@allisterb
allisterb committed Mar 21, 2024
1 parent 0d5bb7e commit 454fc20
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 30 deletions.
59 changes: 33 additions & 26 deletions src/Stratis.VS.StratisEVM/README.html
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,37 @@
<html>
<body>
<h2>About</h2>
<p>The StratisEVM extension provides support for developing Stratis Solidity smart contracts inside Visual Studio.</p>
<h2>Features</h2>
<ul>
<li>Uses <a href="https://github.com/juanfranblanco/vscode-solidity">vscode-solidity</a> language server</li>
<li>Integrates with Visual Studio &quot;Open Folder&quot;</li>
<li>Syntax highlighting and hover information</li>
<li>Intellisense</li>
<li>Linting</li>
<li>Compiling a Solidity file from inside Visual Studio</li>
</ul>
<h2>Requirements</h2>
<ul>
<li>Visual Stdio 2022</li>
<li>A recent version of <a href="https://nodejs.org/">Node.js</a></li>
</ul>
<h2>Usage</h2>
<p>
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'.
</p>
<p>
The first time you open a folder with Solidity contracts the extension will install the necessary Node.js modules in the extension's private <code>node_modules</code> 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.
</p>
<h2>About</h2>
<p>The StratisEVM extension provides support for developing Stratis Solidity smart contracts inside Visual Studio.</p>
<h2>Features</h2>
<ul>
<li>Uses <a href="https://github.com/juanfranblanco/vscode-solidity">vscode-solidity</a> language server</li>
<li>Integrates with Visual Studio &quot;Open Folder&quot;</li>
<li>Syntax highlighting and hover information</li>
<li>Intellisense</li>
<li>Linting</li>
<li>Compile a Solidity file from inside Visual Studio</li>
</ul>
<h2>Requirements</h2>
<ul>
<li>Visual Studio 2022</li>
<li>A recent version of <a href="https://nodejs.org/">Node.js</a></li>
</ul>
<h2>Usage</h2>
<p>Use the Visual Studio Open Folder... feature to open a folder with Solidity contracts. Your folder should contain one of the following files:</p>
<ul>
<li>remappings.txt</li>
<li>foundry.toml</li>
<li>brownie-config.yaml</li>
<li>truffle-config.js</li>
<li>hardhat.config.js</li>
<li>hardhat.config.ts</li>
</ul>
<p>which indicates it is a Solidity project folder. (This is needed for things like error-checking as-you-type by the Solidity compiler.)</p>
<p>Edit a Solidity file as normal. To compile a Solidity file, right-click on the file in Solution Explorer and select 'Compile Solidity File'.</p>
<p>
The first time you open a folder with Solidity contracts the extension will install the necessary Node.js modules in the extension's private <code>node_modules</code> 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.
</p>
</body>
</html>
15 changes: 12 additions & 3 deletions src/Stratis.VS.StratisEVM/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Stratis.VS.StratisEVM/source.extension.vsixmanifest
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
<Metadata>
<Identity Id="Stratis.VS.StratisEVM.09bed5a1-7734-4cff-9412-d17961f1a291" Version="0.1" Language="en-US" Publisher="Stratis DevEx" />
<Identity Id="Stratis.VS.StratisEVM.09bed5a1-7734-4cff-9412-d17961f1a291" Version="0.1.1" Language="en-US" Publisher="Stratis DevEx" />
<DisplayName>StratisEVM</DisplayName>
<Description xml:space="preserve">StratisEVM smart contracts extension</Description>
<MoreInfo>https://github.com/stratisdevex/Stratis.DevEx/tree/master/src/Stratis.VS.StratisEVM</MoreInfo>
Expand Down

0 comments on commit 454fc20

Please sign in to comment.