Skip to content

Commit 53cc34b

Browse files
authored
doc(setup): min node version (#1619)
1 parent dd3a86d commit 53cc34b

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

src/documentation/print-onboarding-wiki.ts

+6-2
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,18 @@ function print(): string {
88
return `${autoGenHeader({ filename: module.filename, purpose: 'developer onboarding process' })}
99
1010
To get started developing on *flowR*, we recommend carefully reading the following pages:
11-
- 💻 [Setting up the *flowR* development environment](${FlowrWikiBaseRef}/Setup#%EF%B8%8F-building-from-scratch). This page explains how to install **R** and **Node.js**.
12-
- 💖 [Contributing guidelines](${FlowrGithubBaseRef}/flowr/tree/main/.github/CONTRIBUTING.md). This page also includes information about how to set up **git-lfs** and several **git hooks**.
11+
- 💻 [Setting up the *flowR* development environment](${FlowrWikiBaseRef}/Setup#%EF%B8%8F-building-from-scratch).\
12+
This page explains how to install **R** and **Node.js**.
13+
- 💖 [Contributing guidelines](${FlowrGithubBaseRef}/flowr/tree/main/.github/CONTRIBUTING.md).\
14+
This page also includes information about how to set up **git-lfs** and several **git hooks**.
1315
1416
## ⌛ TL;DR
1517
1618
The most important steps to get the *flowR* development environment set up (after installing **R** and **Node.js**) can be seen below. For convenience, they can be executed all at once using the following command:
1719
${codeBlock('shell', 'npm run setup:dev')}
1820
21+
If you want to execute the steps manually, please follow the instructions below:
22+
1923
${codeBlock('shell', `
2024
# Installing git-lfs for your current user (if you haven't already)
2125
git lfs install

wiki/Setup.md

+1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Again, you only require this for the [`r-shell` engine][r-shell].
6060
### Installing Node.js
6161

6262
Furthermore, you need the [node package manager](https://www.npmjs.com/) (for Linux, we recommend using [nvm](https://github.com/nvm-sh/nvm)).
63+
To work, we currently rely on node versions starting from `22.x`.
6364

6465
### Installing _flowR_
6566

wiki/_Footer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
**Currently maintained by Florian Sihler**\
1+
**Currently maintained by [Florian Sihler](https://www.uni-ulm.de/in/sp/team/florian-sihler) at Ulm University**\
22
[Email](mailto:florian.sihler@uni-ulm.de) | [GitHub](https://github.com/EagleoutIce) | [Penguins](https://github.com/EagleoutIce/tikzpingus) | [Portfolio](https://eagleoutice.github.io/portfolio/)

0 commit comments

Comments
 (0)