Skip to content

Commit

Permalink
docs: update NodeJS version requirements (#207)
Browse files Browse the repository at this point in the history
  • Loading branch information
HipsterBrown authored Jan 5, 2025
1 parent 79d454c commit 4477e15
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Moddable SDK and associated dev board tooling is incredibly empowering for e

## Requirements

[Node.js >= v16](https://nodejs.org/en/)
[Node.js](https://nodejs.org/en/), at least the [active LTS version](https://nodejs.org/en/about/previous-releases#nodejs-releases).

_If you've never installed Node.js before, check out the [getting started guide for xs-dev](https://hipsterbrown.github.io/xs-dev/guide/00-prepare#nodejs-package-manager-optional)._

Expand Down Expand Up @@ -154,4 +154,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
8 changes: 4 additions & 4 deletions docs/src/content/docs/features/doctor.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ This should output something like this:

```
xs-dev environment info:
CLI Version 0.19.3
CLI Version 0.36.5
OS Darwin
Arch arm64
NodeJS Version v16.14.0 (/path/to/node)
Python Version 3.10.9 (/path/to/python)
Moddable SDK Version 3.5.0 (/path/to/moddable)
NodeJS Version v22.10.0 (/path/to/node)
Python Version 3.12.8 (/path/to/python)
Moddable SDK Version 5.3.3 (/path/to/moddable)
Supported target devices mac, esp32, esp8266, pico
ESP32 IDF Directory /path/to/esp32/esp-idf
ESP8266 Base Directory /path/to/esp
Expand Down
7 changes: 4 additions & 3 deletions docs/src/content/docs/guide/00-prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ These are not the only available editors, so feel free to do your own research a

## NodeJS & Package Manager (optional)

While [NodeJS](https://nodejs.org/en/) is not required for [Moddable XS](https://github.com/Moddable-OpenSource/moddable) projects, it is a dependency for installing and using the [`xs-dev` CLI](https://xs-dev.js.org/).
While [NodeJS](https://nodejs.org/en/) is not required for [Moddable XS](https://github.com/Moddable-OpenSource/moddable) projects, it is a dependency for installing and using the [`xs-dev` CLI](https://xs-dev.js.org/). It supports at least the [active Long Term Support (LTS) version](https://nodejs.org/en/about/previous-releases#nodejs-releases).

Node can be [downloaded directly from the website](https://nodejs.org/en/download/), however using one of the following version managers can help with quickly switching to recommended versions of the tooling in the future:
NodeJS can be [downloaded directly from the website](https://nodejs.org/en/download/), however using one of the following version managers can help with quickly switching to recommended versions of the tooling in the future:

- [mise](https://mise.jdx.dev/getting-started.html#_1-install-mise-cli)
- [`pnpm env`](https://pnpm.io/cli/env)
- [Volta](https://volta.sh/)
- [fnm](https://github.com/Schniz/fnm)
- [asdf](https://asdf-vm.com/guide/getting-started.html#_4-install-a-plugin)

Node comes with [npm](https://docs.npmjs.com/cli/v8/commands/npm) as the included package manager, but there are other options available if needed:
NodeJS comes with [npm](https://docs.npmjs.com/cli/v8/commands/npm) as the included package manager, but there are other options available if needed:

- [pnpm](https://pnpm.io/installation)
- [yarn](https://yarnpkg.com/)
Expand Down Expand Up @@ -72,6 +72,7 @@ Simulators are fun and everything, but controlling hardware with JavaScript is e
- [ESP8266](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp8266.md)
- [ESP32](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp32.md)
- [Raspberry Pi Pico](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/pico.md)
- [Nordic nRF52840](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/nrf52.md)

Each platform has a variety of features and form factors to support whatever you might dream up. This guide will do its best to provide code and diagrams that match the expectations of your chosen device(s) but cannot promise comprehensive coverage of every piece of hardware in existence.

Expand Down
8 changes: 4 additions & 4 deletions docs/src/content/docs/guide/01-hello-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,12 @@ Running [`xs-dev doctor` command](/features/doctor) will display relevant info a

```
xs-dev environment info:
CLI Version 0.19.3
CLI Version 0.36.5
OS Darwin
Arch arm64
NodeJS Version v16.14.0 (/path/to/node)
Python Version 3.10.9 (/path/to/python)
Moddable SDK Version 3.5.0 (/path/to/moddable)
NodeJS Version v22.10.0 (/path/to/node)
Python Version 3.12.8 (/path/to/python)
Moddable SDK Version 5.3.3 (/path/to/moddable)
Supported target devices mac
If this is related to an error when using the CLI, please create an issue at "https://github.com/hipsterbrown/xs-dev/issues/new" with the above info.
Expand Down

0 comments on commit 4477e15

Please sign in to comment.