@@ -52,14 +52,16 @@ v6.2.1
5252
5353### Fork, Clone & Install  
5454
55- Start by [ forking stardust ] [ 12 ]  to your GitHub account.  Then clone your fork and install dependencies:
55+ Start by [ forking Semantic UI React ] [ 12 ]  to your GitHub account.  Then clone your fork and install dependencies:
5656
5757``` sh 
5858git clone git@github.com:< your-user> /Semantic-UI-React.git
5959cd  Semantic-UI-React
60- npm install 
60+ yarn 
6161``` 
6262
63+ > Note, we use ` yarn `  because ` npm `  has unfortunately become unreliable.  Get it [ here] [ 16 ] .
64+ 
6365Add our repo as a git remote so you can pull/rebase your fork with our latest updates:
6466
6567``` 
@@ -72,25 +74,24 @@ Please follow the [Angular Git Commit Guidelines][8] format.
7274
7375### Commands  
7476
75- > This list is not updated, you should run ` npm  run`  to see all scripts.
77+ > This list is not updated, you should run ` yarn  run`  to see all scripts.
7678
7779``` sh 
78- npm start                     // run doc site
79- npm run start:local-modules   // run offline (slower builds)
80+ yarn start                 // run doc site
8081
81- npm  test                        // test  once
82- npm run  test:watch            // test  on file change
82+ yarn  test                   // test  once
83+ yarn  test:watch            // test  on file change
8384
84- npm run  build                 // build everything
85- npm run  build:dist            // build dist
86- npm run  build:docs            // build docs
87- npm run  build:docs-toc        // build toc for  markdown files
85+ yarn  build                 // build everything
86+ yarn  build:dist            // build dist
87+ yarn  build:docs            // build docs
88+ yarn  build:docs-toc        // build toc for  markdown files
8889
89- npm run  deploy:docs           // deploy gh-pages doc site
90+ yarn  deploy:docs           // deploy gh-pages doc site
9091
91- npm run  lint                  // lint once
92- npm run  lint:fix              // lint and attempt to fix
93- npm run  lint:watch            // lint on file change
92+ yarn  lint                  // lint once
93+ yarn  lint:fix              // lint and attempt to fix
94+ yarn  lint:watch            // lint on file change
9495``` 
9596
9697## Workflow  
@@ -371,7 +372,7 @@ See [`src/factories`][13] for special methods to convert props values into React
371372
372373## Testing  
373374
374- Run tests during development with ` npm run  test:watch`  to re-run tests on file changes.
375+ Run tests during development with ` yarn  test:watch`  to re-run tests on file changes.
375376
376377### Coverage  
377378
@@ -494,7 +495,7 @@ Our docs are generated from doc block comments, `propTypes`, and hand written ex
494495Developing against the doc site is a good way to try your component as you build it. Run the doc site with:
495496
496497``` sh 
497- npm  start
498+ yarn  start
498499``` 
499500
500501### Components  
@@ -571,3 +572,4 @@ Adding documentation for new components is a bit tedious.  The best way to do th
571572[ 13 ] : https://github.com/Semantic-Org/Semantic-UI-React/blob/master/src/factories 
572573[ 14 ] : https://github.com/Semantic-Org/Semantic-UI-React/pull/335#issuecomment-238960895 
573574[ 15 ] : https://github.com/Semantic-Org/Semantic-UI-React/issues/607 
575+ [ 16 ] : https://yarnpkg.com/en/docs/getting-started 
0 commit comments