Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit dbcc99c

Browse files
authored
docs(setup): instructs to delete non-essential files (#3079)
1 parent 30e44ad commit dbcc99c

File tree

3 files changed

+52
-1
lines changed

3 files changed

+52
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.git
2+
.gitignore
3+
.travis.yml
4+
*.spec*.ts
5+
CHANGELOG.md
6+
e2e
7+
favicon.ico
8+
karma.conf.js
9+
karma-test-shim.js
10+
LICENSE
11+
non-essential-files.txt
12+
protractor.config.js
13+
README.md

public/docs/ts/latest/guide/setup-systemjs-anatomy.jade

+9
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,15 @@ table(width="100%")
9090
:marked
9191
Script to run <a href="https://karma-runner.github.io/1.0/index.html" target="_blank" title="Karma unit test runner">karma</a>
9292
with SystemJS as described in the [Testing](testing.html) guide.
93+
tr
94+
td <code>non-essential-files.txt</code>
95+
td
96+
:marked
97+
A list of files that you can delete if you want to purge your setup of the
98+
original QuickStart Seed testing and git maintainence artifacts.
99+
See instructions in the optional
100+
[_Deleting non-essential files_](setup.html#non-essential "Setup: Deleting non-essential files") section.
101+
*Do this only in the beginning to avoid accidentally deleting your own tests and git setup!*
93102
tr
94103
td <code>LICENSE</code>
95104
td

public/docs/ts/latest/guide/setup.jade

+30-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,36 @@ code-example(language="sh" class="code-shell").
6464
:marked
6565
`npm start` fails in _Bash for Windows_ which does not support networking to servers as of January, 2017.
6666

67-
.l-main-section#seed
67+
a#non-essential
68+
.l-main-section
69+
:marked
70+
## Delete _non-essential_ files (optional)
71+
72+
You can quickly delete the _non-essential_ files that concern testing and QuickStart repository maintenance
73+
(***including all git-related artifacts*** such as the `.git` folder and `.gitignore`!).
74+
75+
.alert.is-important
76+
:marked
77+
Do this only in the beginning to avoid accidentally deleting your own tests and git setup!
78+
79+
:marked
80+
Open a terminal window in the project folder and enter the following commands for your environment:
81+
82+
### OS/X (bash)
83+
code-example(language="sh" class="code-shell").
84+
xargs -a non-essential-files.txt rm -rf
85+
rm app/*.spec*.ts
86+
rm non-essential-files.txt
87+
88+
:marked
89+
### Windows
90+
code-example(language="sh" class="code-shell").
91+
for /f %i in (non-essential-files.txt) do del %i /F /S /Q
92+
rd .git /s /q
93+
rd e2e /s /q
94+
95+
a#seed
96+
.l-main-section
6897
:marked
6998
## What's in the QuickStart seed?
7099

0 commit comments

Comments
 (0)