geoff
/
riot-starter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme

This commit is contained in:
Geoff Doty 2019-01-01 15:34:49 -05:00
parent 6896091da6
commit baa6586252
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -44,30 +44,29 @@ A production pipe-line should *NOT* be in your way while **developing**. You sho
1. Run `npm install`, this will install all vendor dependencies 1. Run `npm install`, this will install all vendor dependencies
2. Start coding in `src/public` 2. Start coding in `app`
3. run the `public/index.html` from your favorite web server\* 3. run the `app/index.html` from your favorite web server\*
> \* try `live-server` from `npm` or via [Visual Studio Code]() plug-in it's awesome! > \* try `live-server` from `npm` or via [Visual Studio Code]() plug-in it's awesome!
### Project Structure ### Project Structure
``` ```
src/ app/ <-- develop here
public/ <-- develop here css/ <-- your css files
css/ <-- your css files js/ <-- your javascript files
js/ <-- your javascript files app.js <-- basic routing/utils bootstrap
app.js <-- basic routing/utils bootstrap images/ <-- your images
images/ <-- your images tags/ <-- web-components
tags/ <-- web-components vendor/ <-- vendor dependencies, ie code you did not write
vendor/ <-- vendor dependencies, ie code you did not write index.html <-- start here
index.html <-- start here ... <-- web meta files
... <-- web meta files docs/ <-- additional documentation
docs/ <-- additional documentation test/ <-- tests (one day)
test/ <-- tests (one day) gulpfile.js <-- task runner
gulpfile.js <-- task runner
README.md README.md
... <-- misc project meta files ... <-- misc project meta files
``` ```
### Web Components ### Web Components