From 02b088447ec1c6deafc67a64eb076c9f2f2fc889 Mon Sep 17 00:00:00 2001
From: "jvanboxtel@wisc.edu" <jvanboxtel@wisc.edu>
Date: Mon, 29 Jan 2018 16:54:47 -0600
Subject: [PATCH] improved readme

---
 README.md       |  51 +++++++++++++++++++++++++++++++++++++++++++++++-
 src/favicon.ico | Bin 5430 -> 5430 bytes
 2 files changed, 50 insertions(+), 1 deletion(-)
 mode change 100644 => 100755 src/favicon.ico

diff --git a/README.md b/README.md
index abb9cd8..88924fc 100644
--- a/README.md
+++ b/README.md
@@ -39,4 +39,53 @@ Have a look at the `package.json` for more a more detailed view.
 
 ## Developing
 ### [Visual Studio Code](https://code.visualstudio.com/)
-Works great with typescript ecosystem.
\ No newline at end of file
+Works great with typescript ecosystem.
+
+## Basic project structure
+<pre> app
+|   |-- app.component.html
+|   |-- app.component.scss
+|   |-- app.component.spec.ts					# All tests end with .spec.ts
+|   |-- app.component.ts
+|   |-- app.module.ts  							# Parent app module
+|   |-- app.routing.module.ts				    # Primary place to add new routes
+|   |-- core
+|   |   |-- config.service.ts 					# Used for config vars
+|   |   |-- core.module.ts
+|   |   |-- data.service.spec.ts				# Designed to mock data
+|   |   |-- data.service.ts						# One catch all service for data transmission
+|   |   |-- models 								# Placeholder for user created models/interfaces
+|   |   |-- module-import-check.ts 				# Prevents the core module from loading twice.
+|   |   `-- navigation						    # Shared navigation component
+|   |       |-- navigation.component.html
+|   |       |-- navigation.component.scss
+|   |       |-- navigation.component.spec.ts
+|   |       `-- navigation.component.ts
+|   |-- home 									# Starter component using the router
+|   |   |-- home.component.html
+|   |   |-- home.component.scss
+|   |   |-- home.component.spec.ts
+|   |   `-- home.component.ts 	
+|   `-- shared									# App wide shared directory. All modules could have a shared Directory too
+|       `-- shared.module.ts  					# Only add Material components here!
+|-- assets
+|   |-- material-theme.scss  					# Custom Material theme
+|   `-- uwstyle				  					# Copy of UWStyle
+|       |-- dist
+|       |-- fonts
+|       `-- images
+|-- index.html									# html entry point gets app.component
+|-- main.ts
+|-- polyfills.ts								# Enables compatibility for older browsers
+|-- styles.css									# Could be used for global styles/imports
+|-- test.ts										# Required by karma
+|-- tsconfig.app.json
+|-- tsconfig.spec.json
+`-- typings.d.ts
+
+../.angular-cli.json 							# All project config for the angular cli
+../tslint.json 									# All project lint settings ex: "ng lint"
+../e2e/											# All project end to end tests ex: "ng e2e"
+../tsconfig.json 								# Primary typescript config
+</pre>
+
diff --git a/src/favicon.ico b/src/favicon.ico
old mode 100644
new mode 100755
index 8081c7ceaf2be08bf59010158c586170d9d2d517..ee4bf259f972975488b6ad2c5d4232a7fa54a844
GIT binary patch
literal 5430
zcmc&&TZm0j7~V5;3PlZh@PH06&7%~eMhHogYf?l<O<p8~B&EpZ#e?EWDY+#i<c&#F
zX5@M_Xk6!vF(!i<#%;`;S@yTK@9h7qz4ku)G~us()?RD<|Ns5>-HhXuIHgW`x#LpO
zS)Xv63cMw~{aN??kb73?Zoz`%68-DG40IoZ5+(IDiPCyyJ_q);=g!8AOsmw|*SUQj
zZ-{(nM^+6VdQZzNTk=v}zVs!w{G^Fb6sT%iqn6pXr&WDu&&HPDxFMtE*QJ`Y%(bgs
zdS5xdA*jP*|GBfBn*ZSbR?Xki(yRAtR$F3Vk<T>sXny!SV)z67-qX{kjvRhp5FfDy
z)!zK69yfHWMGIf({iO@vRQh3eLHSiHUupj8)LRA2T{~O!zG})dy)PefH(!TgKWs$q
zzy|^*{725)+IrROS<fQn!H;-*{8_DoxxaY+v)Z<`IaHpQJGQ^kJU6a?)AE$rys0@@
zN5cLE^SxNjobJ^Pd;!gy`&{drI{B&gA*_B;XFq=QslkKpXnx><SjPhrw^dhHR*f6;
z$oJt7KJwi5u2;u+>0%EL_8^DETe19w)_?rir`#F)514b@*y0&CHm&cIqtfd1$&MT^
z&T)_apw6<=`ZHxEw_b-ml@;mGJIEO0py(~;OwxU3xKD1*;J~0nY29wx9A}+0p;1+*
z-sSw1GUG=#sBK#;y=0kVzFcwmM-O+Z&mDbM{1uD6x)?V2zV+V6lykK>{Mwt{y7p|k
z_U-wo@8-^Y_1Ew<fcs;^plz_jW}p2mzW=}^*=hiJ0l^MCmW(^!<Kr{Fz%YG8?UBOj
z!){Z2e8v|zSFe1}^O3bj8_*|qJo?QwK0f0Mj7RBTdHQ8+aBs_x-JW>(@W&*n5Al$6
z>crPP`y_Avdpvy16_b#2>dIuiZyI^b_>eES#>0m{Cb0)GZ)_BA4#mSa{R19*K=!4q
z5!x5@nYD+tFuvJa>;ueV=$5sIJH%ev*I#_uTc|VUf^$aJ9&9o1`-=}hNvK2m%Q+)+
z16$F1Al~;EpYeoF<W$DPtUc^yz6#Hw==_`d;ftIFj0J2%9Ox_Su<#s;#+S9td;^2T
zTEt$?WY$FCITVdA{lh!`lR2j?@}Bdm@EnT9m;NE|#Fyv9m;El|Mj87WjZfWJ<vf#d
zA&;q_=h7~dCu;u4Iy2+Q_!7gs2M%K-^HL1H#Ne!>yo@hwu+<r3B<qs${u&;C)-d#&
zePs3}Z1r_|^PO`ddJcu-vxk8%zqQ1{Imwn|X`@Zv(__b%Gfd7EVq;}~VS_xE@0^`x
z{Cu7uKJ4Z<1iBFin}6hi9lk#Q+lu&ePQVU(41)M(ZNUbRiNX3ZYm<DQl>ck*gCIWa
z1h4r}FIU<b7F$!^7Q?9iCr;SP`B3;9=jSA-E9ifaCtThh({O%McbQYS*8O|G=6^lL
MzXSg1cDIZ68$Pv;umAu6

literal 5430
zcmc(je{54#6vvCoAI3i*G5%$U7!sA3wtMZ$fH6V9C`=eXGJb@R1%(I_{vnZtpD{6n
z5Pl{DmxzBDbrB>}`90e12m8T*36WoeDLA&SD_hw{H^wM!cl_RWcVA!I+x87ee975;
z@4kD^=bYPn&pmG@(+JZ`rqQEKxW<}RzhW}I!|ulN=fmjVi@x{p$cC`)5$a!)X&U<D
zFCrQtlPskre}dB7oMCp>+blKNvN5tg=uLvuLnuqRM;Yc*swiexsoh#XPNu{9F#c`G
zQLe{yWA(Y6(;>y|-e<R78l|^`vH6ft-mErSG~Y`TZF2qm1=W=MNd^2V3)n2xIl=~X
zcQ9VjzHW38ty|rZz+bkcR(-c)`wbqC#l0CF>fAy11k<09(@Oo1B2@0`PtZSkqK&${
zgEY}`W@t{%?9u5rF?}Y7OL{338l<M%K~-+w4iJ-2C_>*JY#P!%MVQY@oqnItpZ}?s
z!r?*kwuR{A@jg2Chlf0^{q*>8n5Ir~YWf*wmsh7B5&EpHfd5@xVaj&gqsdui^spyL
zB|kUoblGoO7G(MuKTfa9?pGH0@QP^b#!lM1yHWLh*2iq#`C1TdrnO-d#?Oh@XV2HK
zKA{`eo{--^K&MW66Lgsktfvn#cCAc*(}qsfhrvOjMGLE?`dHVipu1J3Kgr%g?cNa8
z)pkmC8DGH~fG+dlrp(5^-QBeEvkOvv#q7MBVLtm2oD^$lJZx--_=K&Ttd=-krx(Bb
zcEoKJda@S!%%@`P-##$>*u%T*mh+QjV@)Qa=Mk1?#zLk+M4tIt%}wagT{5<jKE$zW
zf^v7jW~uUE-%mB7^CHH8TL1|_urI~hKTTLO4e;Zw7r~I(052QT!nq=k3BK4rWn{P1
zm1bHmzb3QsEPddOfehts!4+*he<-J0Tp_H*ozKD(I$*vEIRc5vL3kd@p{$kjMIKQs
z<pI0(Vu7$}v<2fENHCVA=ZgE(eBp=9a;_O`BkfrU-cm?UdhYP}+z)k)*4wQOW0K7S
zxLV9h7PeF2dOvMg->J%!tXAE;r{@=bb%nNVxvI+C+$t?!VJ@0d@HIyMJTI{vEw0Ul
ze(ha!e&qANbTL1ZneNl45t=#Ot??C0MHjjgY8%*mGisN|S6%g3;Hlx#fMNcL<87MW
zZ>6moo1YD?P!fJ#Jb(4)_cc50X5n0KoDYfdPoL^iV`k&o{LPyaoqMqk92wVM#_O0l
z09$(A-D+gVIlq4TA&{1T@BsUH`Bm=r#l$Z51J<A&BjWib@$s|gZJQqmbJQD%pmuqr
zlRi3r%o8I$s7b`Nd|6!*{)IIXevOQu?P#Tr`(a_yaC`Z3mz2%s0J*VP!oMryv%aGJ
zJ%+hr;JUR9N%=NQUAcsxH1Ev(z=Jw5x*3ZP^w64B9T1;d$FN#v|K3{yO?U3}p#~CX
zQeul5J0S-k&QP-WS^uxU^lJ9qPEkik*MChluj|;LEt~#I8atbRn<NLMVzYM(P(Mc^
z+=Vcf!|a)D*bAJ$B)>-U&F32+hfUP-iLo=jg7Xmy+WLq6_tWv&`wDlz#`&)Jp~iQf
zZP)tu>}pIIJKuw+$&t}GQuqMd%Z>0?t%&BM&W<om&b&wS^Ui5`y0`bK`dz>o^4P^Y
z)c6h^f2R>X8*}q|bblAF?@;%?2>$y+cMQbN{X$)^R>v<j%HOoXFL3nF-$ASizAu7L
zA~a)K^qdiKCTsOM0PF^%{K=Uu<ZEZkC-ypeB>tNq_5AB|0N5U*d^T?X9{xQnJYeU{
zoZL#obI;~Pp95f1`%X3D$Mh*4^?O?IT~7HqlWguezmg?Ybq|7>qQ(@pPHbE9V?f|(
z+0xo!#m@Np9PljsyxBY-UA*{U*la#8Wz2sO|48_-5t8%_!n?S$zlGe+NA%?vmxjS-
zHE5O3ZarU=X}$7>;Okp(UWXJxI%G_J-@IH;%5#Rt$(WUX?6*Ux!IRd$dLP6+SmPn=
z8zjm4jGjN772R{FGkXwcNv8GBcZI#@Y2m{RNF_w8(Z%^A*!bS*!}s6sh*NnURytky
humW;*g7R+&|Ledvc-<M)bUEqtWbbwV3iw}c{{uEu@7@3a

-- 
GitLab