Skip to content

Commit 1d8ca03

Browse files
committed
Improved contents of non-root README.md files
1 parent 23da372 commit 1d8ca03

File tree

5 files changed

+39
-3
lines changed

5 files changed

+39
-3
lines changed

bin/README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
1+
This file is in the `bin` directory.
2+
3+
This directory is the primary output directory for libraries and NuGet packages when using the build system
4+
(i.e. `build.cmd` or `build.fsx`). It is also the target directory when building in *Release* mode inside Visual Studio.
5+
This directory is touched by many parts of the build process.
6+
7+
**It is strongly recommended that nothing be put into this directory.**
8+
9+
It is **strongly advised** that the **contents of this directory not be committed** to source control
10+
(with the sole exception being this `README.md` file).
11+
12+
---
13+
NOTE:
14+
115
This file is a placeholder, used to preserve directory structure in Git.
2-
It does not need to be edited.
16+
17+
This file does not need to be edited.

lib/README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
1+
This file is in the `lib` directory.
2+
3+
Any **libraries** on which your project depends and which are **NOT managed via NuGet** should be kept **in this directory**.
4+
This typically includes custom builds of third-party software, private (i.e. to a company) codebases, and native libraries.
5+
6+
---
7+
NOTE:
8+
19
This file is a placeholder, used to preserve directory structure in Git.
2-
It does not need to be edited.
10+
11+
This file does not need to be edited.

nuget/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
This file is in the `nuget` directory.
2+
23
You should use this directory to store any artifacts required to produce a NuGet package for your project.
34
This typically includes a `.nuspec` file and some `.ps1` scripts, for instance.
45
Additionally, this example project includes a `.cmd` file suitable for manual deployment of packages to http://nuget.org.

packages/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
This file is in the `packages` directory.
2+
23
Any NuGet packages on which your project depends will be downloaded to this directory.
34
Additionally, packages required by the build process will be stored here.
45

temp/README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1+
This file is in the `temp` directory.
2+
3+
This directory is used by the build process as a "scratch", or working, area.
4+
5+
**It is strongly recommended that nothing be put into this directory.**
6+
7+
---
8+
NOTE:
9+
110
This file is a placeholder, used to preserve directory structure in Git.
2-
It does not need to be edited.
11+
12+
This file does not need to be edited.

0 commit comments

Comments
 (0)