Skip to content

Commit eda3873

Browse files
committed
chore: add non-essential-files.txt and instrucs
1 parent 588fd3c commit eda3873

File tree

3 files changed

+48
-9
lines changed

3 files changed

+48
-9
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@ Upgraders: for a fresh start, consider running these commands
33
* `git clean -xdf`
44
* `npm install`
55

6+
<a name="0.2.22"></a>
7+
# 0.2.22 (2017-01-05)
8+
* Add `non-essential-files.txt` and instructions to use it to README
9+
610
<a name="0.2.21"></a>
7-
# 0.2.20 (2016-12-14)
11+
# 0.2.21 (2016-12-14)
812
* Update to in-memory-web-api v.0.2.1
913

1014
<a name="0.2.20"></a>

README.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,33 +28,55 @@ We recommend [nvm](https://github.com/creationix/nvm) for managing multiple vers
2828
## Create a new project based on the QuickStart
2929

3030
Clone this repo into new project folder (e.g., `my-proj`).
31-
```bash
32-
git clone https://github.com/angular/quickstart my-proj
31+
```shell
32+
git clone https://github.com/angular/quickstart my-proj
3333
cd my-proj
3434
```
3535

3636
We have no intention of updating the source on `angular/quickstart`.
37-
Discard everything "git-like" by deleting the `.git` folder.
38-
```bash
39-
rm -rf .git # non-Windows
37+
Discard the `.git` folder..
38+
```shell
39+
rm -rf .git # OS/X (bash)
4040
rd .git /S/Q # windows
4141
```
42+
### Delete _non-essential_ files (optional)
43+
44+
You can quickly delete the _non-essential_ files that concern testing and QuickStart repository maintenance
45+
(***including all git-related artifacts*** such as the `.git` folder and `.gitignore`!)
46+
by entering the following commands while in the project folder:
47+
48+
##### OS/X (bash)
49+
```shell
50+
xargs -a non-essential-files.txt rm -rf
51+
rm app/*.spec*.ts
52+
rm non-essential-files.txt
53+
```
54+
55+
##### Windows
56+
```shell
57+
for /f %i in (non-essential-files.txt) do del %i /F /S /Q
58+
rd .git /s /q
59+
rd e2e /s /q
60+
```
4261
4362
### Create a new git repo
4463
You could [start writing code](#start-development) now and throw it all away when you're done.
4564
If you'd rather preserve your work under source control, consider taking the following steps.
4665
4766
Initialize this project as a *local git repo* and make the first commit:
48-
```bash
67+
```shell
4968
git init
5069
git add .
5170
git commit -m "Initial commit"
5271
```
5372
73+
>Recover the deleted `.gitignore` from the QuickStart repository
74+
if you lost it in the _Delete non-essential files_ step.
75+
5476
Create a *remote repository* for this project on the service of your choice.
5577
5678
Grab its address (e.g. *`https://github.com/<my-org>/my-proj.git`*) and push the *local repo* to the *remote*.
57-
```bash
79+
```shell
5880
git remote add origin <repo-address>
5981
git push -u origin master
6082
```
@@ -64,7 +86,7 @@ git push -u origin master
6486
6587
Install the npm packages described in the `package.json` and verify that it works:
6688
67-
```bash
89+
```shell
6890
npm install
6991
npm start
7092
```

non-essential-files.txt

Lines changed: 13 additions & 0 deletions
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

0 commit comments

Comments
 (0)