Improved contents of non-root README.md files

bigjonroberts · Oct 29, 2013 · 1d8ca03 · 1d8ca03
1 parent 23da372
commit 1d8ca03
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 3 deletions.
diff --git a/bin/README.md b/bin/README.md
@@ -1,2 +1,17 @@
+This file is in the `bin` directory.
+
+This directory is the primary output directory for libraries and NuGet packages when using the build system 
+(i.e. `build.cmd` or `build.fsx`). It is also the target directory when building in *Release* mode inside Visual Studio.
+This directory is touched by many parts of the build process.
+
+**It is strongly recommended that nothing be put into this directory.**
+
+It is **strongly advised** that the **contents of this directory not be committed** to source control 
+(with the sole exception being this `README.md` file).
+
+---
+NOTE: 
+
 This file is a placeholder, used to preserve directory structure in Git.
-It does not need to be edited.
+
+This file does not need to be edited.
diff --git a/lib/README.md b/lib/README.md
@@ -1,2 +1,11 @@
+This file is in the `lib` directory.
+
+Any **libraries** on which your project depends and which are **NOT managed via NuGet** should be kept **in this directory**.
+This typically includes custom builds of third-party software, private (i.e. to a company) codebases, and native libraries.
+
+---
+NOTE: 
+
 This file is a placeholder, used to preserve directory structure in Git.
-It does not need to be edited.
+
+This file does not need to be edited.
diff --git a/nuget/README.md b/nuget/README.md
@@ -1,4 +1,5 @@
 This file is in the `nuget` directory.
+
 You should use this directory to store any artifacts required to produce a NuGet package for your project.
 This typically includes a `.nuspec` file and some `.ps1` scripts, for instance.
 Additionally, this example project includes a `.cmd` file suitable for manual deployment of packages to http://nuget.org.

diff --git a/packages/README.md b/packages/README.md
@@ -1,4 +1,5 @@
 This file is in the `packages` directory.
+
 Any NuGet packages on which your project depends will be downloaded to this directory.
 Additionally, packages required by the build process will be stored here.
 

diff --git a/temp/README.md b/temp/README.md
@@ -1,2 +1,12 @@
+This file is in the `temp` directory.
+
+This directory is used by the build process as a "scratch", or working, area.
+
+**It is strongly recommended that nothing be put into this directory.**
+
+---
+NOTE: 
+
 This file is a placeholder, used to preserve directory structure in Git.
-It does not need to be edited.
+
+This file does not need to be edited.