fix(docs): Tutorials updates and corrections
This commit is contained in:
Benjamin F
parent
1634f986c4
commit
dcb4b17032
23 changed files with 117 additions and 94 deletions
|
|
@ -60,7 +60,7 @@ But if you're running Linux, you have git, right?
|
|||
|
||||
#### Install yarn
|
||||
|
||||
Our repository uses yarn workspaces. So you'll need yarn to work with it.
|
||||
Our repository uses yarn workspaces. So you'll need `yarn` to work with it.
|
||||
|
||||
To install it run:
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ all the changes you want. To do so, visit https://github.com/freesewing/freesewi
|
|||
|
||||
#### Clone the forked repository
|
||||
|
||||
Now that you have your very own fork, time to clone it locally.
|
||||
Now that you have your very own fork, it's time to clone it locally.
|
||||
|
||||
```bash
|
||||
git clone <url to your fork>
|
||||
|
|
@ -105,7 +105,7 @@ yarn new design
|
|||
|
||||
## Creating a new plugin
|
||||
|
||||
If you'd like to create a new plugin, run the following comand:
|
||||
If you'd like to create a new plugin, run the following command:
|
||||
|
||||
```sh
|
||||
yarn new plugin
|
||||
|
|
@ -113,13 +113,15 @@ yarn new plugin
|
|||
|
||||
## Stand-alone development
|
||||
|
||||
With NodeJS installed, all you need to do to setup the stand-alone development environment is run this command:
|
||||
With Node.js installed, all you need to do to setup the stand-alone development environment is run this command:
|
||||
|
||||
```bash
|
||||
npx @freesewing/new-design@next
|
||||
```
|
||||
|
||||
<Fixme>Remove `@next` tag when v3 is released</Fixme>
|
||||
<Fixme compact>
|
||||
Remove `@next` tag when v3 is releasedi
|
||||
</Fixme>
|
||||
|
||||
After you've answered [some questions](#questions), it will take a while to set
|
||||
everything up. When it's done, you will have a new folder with the development
|
||||
|
|
@ -152,6 +154,12 @@ If you're not certain what to pick, just mash some keys, it doesn't matter.
|
|||
|
||||
#### What package manager to use
|
||||
|
||||
Chose `npm` if you don't have `yarn` are when you're not sure what the heck `yarn` is.
|
||||
Choose `yarn`. Currently, `npm` does not work.
|
||||
|
||||
</Note>
|
||||
|
||||
<Fixme compact>
|
||||
The `npm` issue issue should be fixed by the time v3 is released.
|
||||
The _What package manager to use_ section will need to be updated at that
|
||||
time.
|
||||
</Fixme>
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ title: Getting started on Mac
|
|||
order: 25
|
||||
---
|
||||
|
||||
In this tutorial, we will setup Node JS and initialize the FreeSewing
|
||||
development environment on a Mac system running OS X.
|
||||
In this tutorial, we will setup Node.js and initialize the FreeSewing
|
||||
development environment on a Mac system running macOS.
|
||||
|
||||
<Tip>
|
||||
|
||||
|
|
@ -15,4 +15,4 @@ application at `/Applications/Utilities/`.
|
|||
|
||||
We'll cover the following steps:
|
||||
|
||||
<ReadMore list />
|
||||
<ReadMore />
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
---
|
||||
title: Installing Node
|
||||
title: Installing Node.js
|
||||
order: 20
|
||||
---
|
||||
|
||||
Now we will use nvm to install Node JS. Run the following command:
|
||||
Now we will use `nvm` to install Node.js. Run the following command:
|
||||
|
||||
```bash
|
||||
nvm install lts/gallium
|
||||
```
|
||||
|
||||
This will install the so-called LTS version of Node 16 on your system.
|
||||
This will install the so-called LTS version of Node.js 16 on your system.
|
||||
|
||||
LTS versions -- short for Long Term Support -- are good node versions
|
||||
LTS versions -- short for Long Term Support -- are good Node.js versions
|
||||
to use because they are stable and supported for a long time.
|
||||
|
|
|
|||
|
|
@ -1,20 +1,20 @@
|
|||
---
|
||||
title: Installing nvm
|
||||
order: 10
|
||||
order: 15
|
||||
---
|
||||
|
||||
FreeSewing is built with [Node.js](https://nodejs.org/), a JavaScript runtime.
|
||||
|
||||
You'll need to install Node JS on your system, and to do so, we'll
|
||||
use [nvm](https://github.com/nvm-sh/nvm), short for _Node version manager_.
|
||||
You'll need to install Node.js on your system, and to do so, we'll
|
||||
use [`nvm`](https://github.com/nvm-sh/nvm), short for _Node Version Manager_.
|
||||
|
||||
Using nvm has a number of benefits in comparison with installing Node from
|
||||
the node.js website, or from a package provided by your linux distribution:
|
||||
Using `nvm` has a number of benefits in comparison with installing Node.js from
|
||||
the Node.js website, or from a package provided by your Linux distribution:
|
||||
|
||||
- You can easily switch between different Node versions
|
||||
- You can easily switch between different Node.js versions
|
||||
- Everything gets installed in your home folder, avoiding permission problems
|
||||
|
||||
To setup nvm, [follow the install instructions in the nvm
|
||||
To setup `nvm`, [follow the install instructions in the nvm
|
||||
README](https://github.com/nvm-sh/nvm#installing-and-updating).
|
||||
|
||||
After the installation, try running the following command:
|
||||
|
|
@ -23,7 +23,7 @@ After the installation, try running the following command:
|
|||
nvm
|
||||
```
|
||||
|
||||
If all goes well, it should show you the nvm help.
|
||||
If all goes well, it should show you the `nvm` help.
|
||||
|
||||
<Tip>
|
||||
|
||||
|
|
|
|||
|
|
@ -13,5 +13,5 @@ Open the Terminal application, and type the following command:
|
|||
xcode-select --install
|
||||
```
|
||||
|
||||
A popup will appear asking you to confirm the installation.
|
||||
A pop-up will appear asking you to confirm the installation.
|
||||
Confirm, and go make a cup of coffee while the install does its thing.
|
||||
|
|
|
|||
|
|
@ -1,36 +1,36 @@
|
|||
---
|
||||
title: Using a different Node version
|
||||
order: 40
|
||||
title: Using a different Node.js version
|
||||
order: 30
|
||||
---
|
||||
|
||||
Now that you've got Node setup, we can start setting up the FreeSewing
|
||||
Now that you've got Node.js setup, we can start setting up the FreeSewing
|
||||
development environment.
|
||||
|
||||
But before doing so, let's look at how `nvm` can help you juggle different
|
||||
Node versions.
|
||||
Node.js versions.
|
||||
|
||||
### nvm ls
|
||||
|
||||
To see the different Node versions on your system, run this command:
|
||||
To see the different Node.js versions on your system, run this command:
|
||||
|
||||
```bash
|
||||
nvm ls
|
||||
```
|
||||
|
||||
It will show you a list of local node versions.
|
||||
Either the version number, or an _alias_ that points to a specific version.
|
||||
It will show you a list of local Node.js versions,
|
||||
either the version number or an _alias_ that points to a specific version.
|
||||
You should see the `lts/*` alias in the list which is what we've just installed.
|
||||
|
||||
### nvm ls-remote
|
||||
|
||||
To see all Node versions that are available, not just those you have locally,
|
||||
To see all Node.js versions that are available, not just those you have locally,
|
||||
run this command:
|
||||
|
||||
```bash
|
||||
nvm ls-remote
|
||||
```
|
||||
|
||||
Nvm will now spit out a long list of Node versions that you can install.
|
||||
It will spit out a long list of Node.js versions that you can install.
|
||||
|
||||
### nvm install
|
||||
|
||||
|
|
@ -43,7 +43,7 @@ nvm install <version-or-alias>
|
|||
|
||||
### nvm use
|
||||
|
||||
With multiple Node versions installed, `nvm` allows you to switch between different
|
||||
With multiple Node.js versions installed, `nvm` allows you to switch between different
|
||||
versions. Just tell it which version you want to use:
|
||||
|
||||
```bash
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue