Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit bb9d39b

Browse files
authored
Various minor updates to documentation (#1349)
* Whitespace fixes in CHANGELOG.md * Add missing release dates in changelog * Add unreleased version changelog entry * Add .ackrc file to avoid searching generated output files Ack is an intelligent, recursive grep tool. http://beyondgrep.com/ * Update CONTRIBUTING.md with dev branch info * Whitespace fixes in README.md * Update node.js and npm requirement To the currently oldest sensible version, it is possible that the actual requirement is higher
1 parent 42fd9ee commit bb9d39b

File tree

4 files changed

+38
-18
lines changed

4 files changed

+38
-18
lines changed

.ackrc

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--ignore-dir=out
2+
--ignore-dir=.vscode-test

CHANGELOG.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,36 @@
11
# Change Log
22
All notable changes to this project will be documented in this file.
33

4+
## Version ...the next release...
5+
6+
- Release date: ...
7+
48
## Version 0.4.4
59

10+
- Release date: August 26, 2021
11+
612
### Changed
713
- Serial monitor uses a new backend which doesn't break with updates of VSCode. [#1322](https://github.com/microsoft/vscode-arduino/pull/1322)
814

915
## Version 0.4.3
1016

17+
- Release date: May 12, 2021
18+
1119
### Fixed
1220
- Update node-usb-native to v0.0.20 to fix serial and port selecting [#1257](https://github.com/microsoft/vscode-arduino/issues/1257)
1321
- Updated dependencies
1422

1523
## Version 0.4.2
1624

25+
- Release date: April 22, 2021
26+
1727
### Fixed
1828
- Update app insights key
1929

2030
## Version 0.4.1
2131

32+
- Release date: April 19, 2021
33+
2234
### Added
2335
- Quickpick sketch selection [#1128](https://github.com/microsoft/vscode-arduino/pull/1128) Thanks [@maddogjt](https://github.com/maddogjt)
2436

@@ -31,6 +43,8 @@ All notable changes to this project will be documented in this file.
3143

3244
## Version 0.4.0
3345

46+
- Release date: March 22. 2021
47+
3448
### Added
3549
- Support for Arduino CLI #1017
3650

@@ -358,19 +372,19 @@ Special thanks to [GarethE](https://github.com/keyoke), thank you for your contr
358372

359373
- Release date: August 24, 2017
360374

361-
### Added
375+
### Added
362376
- Add settings for enabled/disable USB detection
363377
- Add Arduino Example tree explorer viewlet
364378
- Contribution from [DeqingSun](https://github.com/DeqingSun): Support multiple versions of Arduino on Mac [#375](https://github.com/Microsoft/vscode-arduino/pull/375)
365379
- Contribution from [DeqingSun](https://github.com/DeqingSun): Add board support for STM32F1 with Arudino_STM32 [#377](https://github.com/Microsoft/vscode-arduino/pull/377)
366380

367-
### Changed
381+
### Changed
368382
- Leverage the output path config to speedup upload/verify
369383
- Fix USB detection issue during uploading [#371](https://github.com/Microsoft/vscode-arduino/pull/371), [372](https://github.com/Microsoft/vscode-arduino/pull/372)
370384
- Contribution from [lialosiu](https://github.com/lialosiu): Fix encoding issue for non UTF-8 [#364](https://github.com/Microsoft/vscode-arduino/pull/364)
371-
- Update the documents with the helps of
385+
- Update the documents with the helps of
372386
- [eduherminio](https://github.com/Microsoft/vscode-arduino/pull/361)
373-
- [Atalanttore](https://github.com/Microsoft/vscode-arduino/pull/381),
387+
- [Atalanttore](https://github.com/Microsoft/vscode-arduino/pull/381),
374388

375389
## Version 0.2.4
376390

@@ -445,7 +459,9 @@ Special thanks to [GarethE](https://github.com/keyoke), thank you for your contr
445459

446460
## Version 0.1.1
447461

448-
- HotFix: Update display tag.
462+
- Release date: April 14, 2017
463+
464+
- HotFix: Update display tag.
449465

450466
## Version 0.1.0
451467

CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ There are many ways that you can contribute, beyond writing code. The goal of th
88

99
If you are interested in writing code to fix issues, first look at the issues with the [help-wanted](https://github.com/Microsoft/vscode-arduino/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label. They should have the context and code pointers needed to get started. If not, then feel free to ask for some, and we will be happy to provide any guidance you need.
1010

11-
When you are doing code fix, please work against [develop](https://github.com/microsoft/vscode-arduino/tree/develop) branch and also submit pull request to develop branch. Changes will be merged into master branch after production release.
11+
When you are doing code fix, please work against [dev](https://github.com/microsoft/vscode-arduino/tree/dev)
12+
branch and also submit pull request to `dev` branch.
13+
Changes will be merged into `master` branch after production release.
1214

1315

1416

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The Arduino IDE can be installed the Arduino [download page](https://www.arduino
2727
### Arduino CLI
2828
The Arduino CLI can be downloaded from the repository's [release page](https://github.com/arduino/arduino-cli/releases/tag/0.13.0)
2929
- The extension has only been tested with v0.13.0.
30-
- If you use the CLI you will have to set `arduino.path` since the CLI does not have a default path.
30+
- If you use the CLI you will have to set `arduino.path` since the CLI does not have a default path.
3131

3232
## Installation
3333
Open VS Code and press <kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open command palette, select **Install Extension** and type `vscode-arduino`.
@@ -138,14 +138,14 @@ The following settings are as per sketch settings of the Arduino extension. You
138138

139139
## Pre- and Post-Build Commands
140140
On Windows the commands run within a `cmd`-, on Linux and OSX within a `bash`-instance. Therefore your command can be anything what you can run within those shells. Instead of running a command you can invoke a script. This makes writing more complex pre-/post-build mechanisms much easier and opens up the possibility to run python or other scripting languages.
141-
The commands run within the workspace root directory and vscode-arduino sets the following environment variables:
142-
**`VSCA_BUILD_MODE`** The current build mode, one of `Verifying`, `Uploading`, `Uploading (programmer)` or `Analyzing`. This allows you to run your script on certain build modes only.
143-
**`VSCA_SKETCH`** The sketch file relative to your workspace root directory.
144-
**`VSCA_BOARD`** Your board and configuration, e.g. `arduino:avr:nano:cpu=atmega328`.
145-
**`VSCA_WORKSPACE_DIR`** The absolute path of your workspace root directory.
146-
**`VSCA_LOG_LEVEL`** The current log level. This allows you to control the verbosity of your scripts.
147-
**`VSCA_SERIAL`** The serial port used for uploading. Not set if you haven't set one in your `arduino.json`.
148-
**`VSCA_BUILD_DIR`** The build directory. Not set if you haven't set one in your `arduino.json`.
141+
The commands run within the workspace root directory and vscode-arduino sets the following environment variables:
142+
**`VSCA_BUILD_MODE`** The current build mode, one of `Verifying`, `Uploading`, `Uploading (programmer)` or `Analyzing`. This allows you to run your script on certain build modes only.
143+
**`VSCA_SKETCH`** The sketch file relative to your workspace root directory.
144+
**`VSCA_BOARD`** Your board and configuration, e.g. `arduino:avr:nano:cpu=atmega328`.
145+
**`VSCA_WORKSPACE_DIR`** The absolute path of your workspace root directory.
146+
**`VSCA_LOG_LEVEL`** The current log level. This allows you to control the verbosity of your scripts.
147+
**`VSCA_SERIAL`** The serial port used for uploading. Not set if you haven't set one in your `arduino.json`.
148+
**`VSCA_BUILD_DIR`** The build directory. Not set if you haven't set one in your `arduino.json`.
149149

150150
For example under Windows the following `arduino.json` setup
151151
```json
@@ -160,7 +160,7 @@ will produce
160160
```
161161
[Starting] Verifying sketch 'test.ino'
162162
Running pre-build command: "IF "%VSCA_BUILD_MODE%"=="Verifying" (echo VSCA_BUILD_MODE=%VSCA_BUILD_MODE% && echo VSCA_BOARD=%VSCA_BOARD%)"
163-
VSCA_BUILD_MODE=Verifying
163+
VSCA_BUILD_MODE=Verifying
164164
VSCA_BOARD=arduino:avr:nano:cpu=atmega328
165165
Loading configuration...
166166
<...>
@@ -221,8 +221,8 @@ You can find the full list of issues on the [Issue Tracker](https://github.com/M
221221
Installation prerequisites:
222222

223223
- [Git](https://git-scm.com/)
224-
- [Node.js](https://nodejs.org/) (>= 6.5.0)
225-
- [Npm](https://www.npmjs.com/) (>= 3.10.3)
224+
- [Node.js](https://nodejs.org/) (>= 12.x)
225+
- [Npm](https://www.npmjs.com/) (>= 6.x)
226226

227227
To *run and develop*, do the following:
228228
- `git clone https://github.com/microsoft/vscode-arduino`

0 commit comments

Comments
 (0)