Summary

Add installation detail on README.md

Review Request #9756 — Created March 7, 2018 and discarded Oct. 26, 2021, 12:14 p.m.

Information

Owner

ridum

Repository

rb-screenshot

Branch

master

Bugs

Depends On

Reviewers

Groups

rb-extension-pack, students

People

Description

Add details of installing development environment on README.md

Testing Done

Issues

Description	From	Last Updated
Summary should start with a capital letter.	david	March 10, 2018, 4:50 p.m.
What about Firefox instructions?	david	March 10, 2018, 5:53 p.m.
Add another blank line here.	david	March 7, 2018, 9:45 p.m.
I'd change the "Installation" subheading to "Installing from git" and then get rid of this line.	david	March 7, 2018, 5:40 p.m.
Typos: navigated -> navigate dirctory -> directory This probably isn't necessary at all, though. People working with this repo should …	david	March 7, 2018, 5:46 p.m.
Sentences should start with capital letters. I think the link should also be inline here: Install [gulp](https://gulpjs.com) by running:	david	March 7, 2018, 5:46 p.m.
If instead we suggest doing sude npm install -g gulp, then below you can just tell people to run gulp …	david	March 10, 2018, 11:11 a.m.
Typos: Seconly -> Secondly installed -> install Line should also end in a colon.	david	March 7, 2018, 5:48 p.m.
Should start with a capital letter and end in a color. Also, typo: followinng	david	March 7, 2018, 5:50 p.m.
Space between "browser" and "(". Should also end in a period.	david	March 7, 2018, 9:29 p.m.
These should probably all be in one paragraph.	david	March 7, 2018, 9:32 p.m.
Where exactly in the UI is "customise and control Google Chrome"? I can't find it. There's also some trailing whitespace …	david	March 12, 2018, 2:18 p.m.
next -> Next ur -> your Period at the end of this sentence.	david	March 7, 2018, 9:33 p.m.
you -> You being installed on -> in Trailing whitespace at the end of this line.	david	March 7, 2018, 9:42 p.m.
Blank line after this.	david	March 10, 2018, 4:51 p.m.
No space before the :.	david	March 10, 2018, 4:51 p.m.
No space before the :.	david	March 10, 2018, 4:51 p.m.
No space before the :. Also theree's an extra space character at the end of the line. Maybe have this …	david	March 10, 2018, 4:51 p.m.
Don't need this--you're telling where the .build directory is later in there.	david	March 10, 2018, 4:55 p.m.
No space before the period.	david	March 10, 2018, 4:55 p.m.

flake8 passed.

JSHint passed.

README.md (Diff revision 1)
Show all issues
```
Add another blank line here.
```

README.md (Diff revision 1)

Show all issues

I'd change the "Installation" subheading to "Installing from git" and then get rid of this line.

README.md (Diff revision 1)

Show all issues

Typos:
navigated -> navigate
dirctory -> directory

This probably isn't necessary at all, though. People working with this repo should probably already have the necessary skills to be in a terminal in their git clone.

README.md (Diff revision 1)

Show all issues

Sentences should start with capital letters. I think the link should also be inline here:

Install [gulp](https://gulpjs.com) by running:

README.md (Diff revision 1)

Show all issues

If instead we suggest doing sude npm install -g gulp, then below you can just tell people to run gulp instead of ./node_modules/.bin/gulp

ridum March 7, 2018, 9:43 p.m.

I think it is better to let the user install gulp library locally than globally because unless they are going to use gulp again gulpJS is useless and it is not going to be deleted when the user remove the project.

david March 12, 2018, 1:27 p.m.
```
Fair enough.
```

README.md (Diff revision 1)

Show all issues

Typos:
Seconly -> Secondly
installed -> install

Line should also end in a colon.

README.md (Diff revision 1)

Show all issues

Should start with a capital letter and end in a color. Also, typo: followinng

README.md (Diff revision 1)

Show all issues

Space between "browser" and "(". Should also end in a period.

README.md (Diff revision 1)

Show all issues

These should probably all be in one paragraph.

README.md (Diff revision 1)

Show all issues

Where exactly in the UI is "customise and control Google Chrome"? I can't find it. There's also some trailing whitespace on this line and the next.

ridum March 7, 2018, 9:43 p.m.

It is on the top right corner where the icon looks like three vertical points. If you hover your mouse on it it will says "customise and control Google Chrome".

david March 12, 2018, 1:27 p.m.

I don't think people will know to look for a tooltip when they're looking for UI strings like this. Let's just say the path in the menus: "Window -> Extensions"

RI

ridum March 12, 2018, 2:18 p.m.
```
Sure, fixed.
```

README.md (Diff revision 1)

Show all issues

next -> Next

ur -> your

Period at the end of this sentence.

README.md (Diff revision 1)

Show all issues

you -> You
being installed on -> in
Trailing whitespace at the end of this line.

Commit:

-	aadc954c63829023010c856bc22fa323374945cb
+	4eb0c7d6ad52395ccf66dfb3b301b92c7aa2d196

Diff:

Revision 2 (+24 -1)

Show changes

README.md

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Show all issues

Summary should start with a capital letter.

Show all issues
```
What about Firefox instructions?
```
README.md (Diff revision 2)
Show all issues
```
Blank line after this.
```
README.md (Diff revision 2)
Show all issues
```
No space before the :.
```
README.md (Diff revision 2)
Show all issues
```
No space before the :.
```

README.md (Diff revision 2)

Show all issues

No space before the :. Also theree's an extra space character at the end of the line.

Maybe have this say "To build the extension, run:"

README.md (Diff revision 2)

Show all issues

Don't need this--you're telling where the .build directory is later in there.

README.md (Diff revision 2)
Show all issues
```
No space before the period.
```

Summary:

-	add installation detail on README.md
+	Add installation detail on README.md

Commit:

-	4eb0c7d6ad52395ccf66dfb3b301b92c7aa2d196
+	5bbc411c2374b22a8d933e4e51c24a69bc2d3b61

Diff:

Revision 3 (+34 -1)

Show changes

README.md

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commit:

-	5bbc411c2374b22a8d933e4e51c24a69bc2d3b61
+	1cd4d8a74181e87defe08f9d8e50844ad4ea84e6

Diff:

Revision 4 (+34 -1)

Show changes

README.md

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Review Board 6.0.1 alpha 0 (dev)

Add installation detail on README.md

Information

Reviewers

Commit:

Diff:

Checks run (2 succeeded)

Summary:

Commit:

Diff:

Checks run (2 succeeded)

Commit:

Diff:

Checks run (2 succeeded)

Status: Discarded