Skip to content

Commit b534c3c

Browse files
authored
Adds file and directory description
1 parent bfd9d0e commit b534c3c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,23 @@ Edit `index/package_index.json` with your preferred json editor (I use Oxygen XM
4646

4747
After you are done editing, use the script `indexToPkgsDirectories.js` to update the individual package.json files.
4848

49+
## Root Files and directory description
50+
51+
```
52+
__css/ // webpage style
53+
__js/ // webpage js->lunr, pk index
54+
agsget/ // tool and plugin to get pkg
55+
index/ // the package index
56+
pkgs // all packages we have
57+
scripts // utility scripts
58+
.gitignore //
59+
.nojekyll // required for GitHub Pages
60+
LICENSE // our license
61+
README.md // this readme
62+
azure-pipelines.yml // the ci for agsget
63+
index.html // website home page
64+
```
65+
4966
## challenges and notes
5067

5168
Here are some challenges I am a bit unsure how to fix:

0 commit comments

Comments
 (0)