Skip to content

Commit 3966d86

Browse files
erriettadarkwing
authored andcommitted
add note about node version (firefox-devtools#7848)
1 parent 5de756a commit 3966d86

2 files changed

Lines changed: 16 additions & 12 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ debugger.html is a hackable debugger for modern times, built from the ground up
2323

2424
> Or take a look at our detailed [getting started][getting-started] instructions.
2525
26+
First, get a recent version of Node.js to run the debugger.
27+
2628
```bash
2729
curl -o- -L https://yarnpkg.com/install.sh | bash -s
2830
git clone https://github.com/devtools-html/debugger.html.git

docs/getting-setup.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,28 @@
22

33
![][debugger-intro-gif]
44

5-
### Step 1. Install Yarn
5+
### Step 1. Get recent version of Node.js.
6+
7+
### Step 2. Install Yarn
68

79
```bash
810
npm i -g yarn
911
```
10-
*Why Yarn and not NPM?*
11-
NPM installs the latest versions. We use [Yarn][yarn] because we want to make sure everyone is using the same libraries.
12+
*Why Yarn and not NPM?*
13+
NPM installs the latest versions. We use [Yarn][yarn] because we want to make sure everyone is using the same libraries.
1214

13-
### Step 2. Install dependencies
15+
### Step 3. Install dependencies
1416

1517
```bash
1618
git clone https://github.com/devtools-html/debugger.html.git
1719
cd debugger.html
1820
yarn install
1921
```
2022

21-
*What should I do if I get an error?*
23+
*What should I do if I get an error?*
2224
Yarn is still new, please comment on this [issue][yarn-issue] if you see anything weird.
2325

24-
### Step 3. Start the Debugger
26+
### Step 4. Start the Debugger
2527

2628
Now that Firefox is open, lets start the development server. In a new terminal tab, run these commands:
2729

@@ -30,24 +32,24 @@ cd debugger.html
3032
yarn start
3133
```
3234

33-
*What does this do?*
35+
*What does this do?*
3436
This command starts a development server.
3537

36-
### Step 4. Open the Debugger
38+
### Step 5. Open the Debugger
3739

3840
Go to `localhost:8000` in any browser to view the Debugger. If everything worked successfully, you should see this [screenshot](https://cloud.githubusercontent.com/assets/254562/20439428/7498808a-ad89-11e6-895d-d6db320c5009.png)
3941

4042
Now,open Firefox by clicking on `Launch Firefox`. [Chrome](#starting-chrome) and [Node](#starting-node) are also available in the Appendix. It's not required, but it's generally nice to close other browsers first.
4143

4244
After Firefox is open, it's nice to go to a page you want to debug. A good sample website is [TodoMVC](http://todomvc.com/examples/vanillajs/).
4345

44-
*Why am I opening Firefox from inside the debugger?*
46+
*Why am I opening Firefox from inside the debugger?*
4547
`Launch Firefox` opens firefox with special permissions that enable remote debugging.
4648

47-
*What should I see?*
48-
Here's a [screenshot][done-screenshot]
49+
*What should I see?*
50+
Here's a [screenshot][done-screenshot]
4951

50-
*What should I do if this doesn't work?*
52+
*What should I do if this doesn't work?*
5153
You can either try to run it [manually](#starting-firefox) or comment on the [issue](https://github.com/devtools-html/debugger.html/issues/1341).
5254

5355
### Next Steps

0 commit comments

Comments
 (0)