Skip to content

Commit e206b77

Browse files
committed
docs($docs): Updated the project structure in the documentation
1 parent 811b4c8 commit e206b77

File tree

2 files changed

+36
-28
lines changed

2 files changed

+36
-28
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,20 +48,23 @@ Create a new `my-app` folder with files for your future project.
4848

4949
```
5050
my-app/
51-
.gitignore
52-
README.md
53-
elm-package.json
54-
public/
55-
favicon.ico
56-
index.html
57-
src/
58-
Main.elm
59-
index.js
60-
main.css
61-
tests/
62-
elm-package.json
63-
Main.elm
64-
Tests.elm
51+
β”œβ”€β”€ .gitignore
52+
β”œβ”€β”€ README.md
53+
β”œβ”€β”€ elm-package.json
54+
β”œβ”€β”€ elm-stuff
55+
β”œβ”€β”€ public
56+
β”‚ β”œβ”€β”€ favicon.ico
57+
β”‚ β”œβ”€β”€ index.html
58+
β”‚ β”œβ”€β”€ logo.svg
59+
β”‚ └── manifest.json
60+
β”œβ”€β”€ src
61+
β”‚ β”œβ”€β”€ Main.elm
62+
β”‚ β”œβ”€β”€ index.js
63+
β”‚ β”œβ”€β”€ main.css
64+
β”‚ └── registerServiceWorker.js
65+
└── tests
66+
β”œβ”€β”€ Tests.elm
67+
└── elm-package.json
6568
```
6669

6770
You are ready to employ the full power of Create Elm App!

β€Žtemplate/README.mdβ€Ž

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,28 @@ const db = new PouchDB('mydb');
6767
```
6868

6969
## Folder structure
70+
7071
```
7172
my-app/
72-
.gitignore
73-
README.md
74-
elm-package.json
75-
public/
76-
favicon.ico
77-
index.html
78-
src/
79-
Main.elm
80-
index.js
81-
main.css
82-
tests/
83-
elm-package.json
84-
Main.elm
85-
Tests.elm
73+
β”œβ”€β”€ .gitignore
74+
β”œβ”€β”€ README.md
75+
β”œβ”€β”€ elm-package.json
76+
β”œβ”€β”€ elm-stuff
77+
β”œβ”€β”€ public
78+
β”‚ β”œβ”€β”€ favicon.ico
79+
β”‚ β”œβ”€β”€ index.html
80+
β”‚ β”œβ”€β”€ logo.svg
81+
β”‚ └── manifest.json
82+
β”œβ”€β”€ src
83+
β”‚ β”œβ”€β”€ Main.elm
84+
β”‚ β”œβ”€β”€ index.js
85+
β”‚ β”œβ”€β”€ main.css
86+
β”‚ └── registerServiceWorker.js
87+
└── tests
88+
β”œβ”€β”€ Tests.elm
89+
└── elm-package.json
8690
```
91+
8792
For the project to build, these files must exist with exact filenames:
8893

8994
- `public/index.html` is the page template;

0 commit comments

Comments
Β (0)