Add installation detail on README.md

Review Request #9756 — Created March 7, 2018 and updated

ridum
rb-screenshot
master
1cd4d8a...
rb-extension-pack, students

Add details of installing development environment on README.md



  • 0
  • 0
  • 19
  • 1
  • 20
Description From Last Updated
david
  1. 
      
  2. README.md (Diff revision 1)
     
     

    Add another blank line here.

  3. README.md (Diff revision 1)
     
     

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

  4. README.md (Diff revision 1)
     
     

    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.

  5. README.md (Diff revision 1)
     
     

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

    Install [gulp](https://gulpjs.com) by running:
    
  6. README.md (Diff revision 1)
     
     

    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

    1. 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.

    2. Fair enough.

  7. README.md (Diff revision 1)
     
     

    Typos:
    Seconly -> Secondly
    installed -> install

    Line should also end in a colon.

  8. README.md (Diff revision 1)
     
     

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

  9. README.md (Diff revision 1)
     
     

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

  10. README.md (Diff revision 1)
     
     
     
     
     
     
     
     
     

    These should probably all be in one paragraph.

  11. README.md (Diff revision 1)
     
     

    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.

    1. 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".

    2. 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"

    3. Sure, fixed.

  12. README.md (Diff revision 1)
     
     

    next -> Next
    ur -> your
    Period at the end of this sentence.

  13. README.md (Diff revision 1)
     
     

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

  14. 
      
david
  1. 
      
  2. What about Firefox instructions?

  3. Summary should start with a capital letter.

  4. README.md (Diff revision 2)
     
     

    Blank line after this.

  5. README.md (Diff revision 2)
     
     

    No space before the :.

  6. README.md (Diff revision 2)
     
     

    No space before the :.

  7. README.md (Diff revision 2)
     
     

    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:"

  8. README.md (Diff revision 2)
     
     

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

  9. README.md (Diff revision 2)
     
     

    No space before the period.

  10. 
      
Review request changed

Commit:

-5bbc411c2374b22a8d933e4e51c24a69bc2d3b61
+1cd4d8a74181e87defe08f9d8e50844ad4ea84e6

Diff:

Revision 4 (+34 -1)

Show changes

Checks run (2 succeeded)

flake8 passed.
JSHint passed.
Loading...