Skip to content

Commit ae2faf8

Browse files
DanielRosenwasserDanielRosenwasser
committed
Merge pull request #5503 from Microsoft/libReadmes
Add 'README.md' files to 'lib' and 'src/lib'.
2 parents 485b3ab + da169de commit ae2faf8

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

‎.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
built
22
doc
3+
lib/README.md
34
scripts
45
src
56
tests

‎lib/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Read this!
2+
3+
These files are not meant to be edited by hand.
4+
If you need to make modifications, the respective files should be changed within the repository's top-level `src` directory.

‎src/lib/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Read this!
2+
3+
The files within this directory are used to generate `lib.d.ts` and `lib.es6.d.ts`.
4+
5+
## Generated files
6+
7+
Any files ending in `.generated.d.ts` aren't mean to be edited by hand.
8+
If you need to make changes to such files, make a change to the input files for our [library generator](https://github.com/Microsoft/TSJS-lib-generator).

0 commit comments

Comments
 (0)