From fd0167a9f3d7e116ab84a38a5210acc49f225862 Mon Sep 17 00:00:00 2001 From: Steve Date: Sun, 27 Jan 2019 01:59:40 -0500 Subject: [PATCH] Update readme for initial release Minor changes to other files, mostly cleanup. --- LICENSE.md => LICENSE-Skeleton.md | 0 README.md | 78 +++++++++++++++++++----------- css/normalize.css | 0 images/favicon-16.png | Bin 0 -> 867 bytes images/favicon.png | Bin 1156 -> 0 bytes index.html | 11 ++--- 6 files changed, 54 insertions(+), 35 deletions(-) rename LICENSE.md => LICENSE-Skeleton.md (100%) mode change 100755 => 100644 css/normalize.css create mode 100644 images/favicon-16.png delete mode 100644 images/favicon.png diff --git a/LICENSE.md b/LICENSE-Skeleton.md similarity index 100% rename from LICENSE.md rename to LICENSE-Skeleton.md diff --git a/README.md b/README.md index e40d200..8e6a20d 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,75 @@ # Barebones Barebones is simple, responsive boilerplate based off the popular [Skeleton](http://getskeleton.com) project by [Dave Gamache](https://twitter.com/dhg). -### Why Barebones? - -Building off of Skeleton's [awesomeness](https://github.com/dhg/Skeleton#why-its-awesome): -- Normalize.css added as a submodule to remain current -- Updated to use CSS variables -- Uses CSS Grid instead of 12-column grid system -- Support for @media prefers-color-scheme (aka Dark Mode) -- Pending Release: Uses CSS env() function -- Possible: Add basic Nav boilerplate - - -## Current Status - -2019-01-20 - updates currently being made on v3 branch. No releases yet. - +While there are several other active forks of Skeleton, Barebones differs by requiring no external tools or dependencies such as CSS pre-processors. Simply download and go. ## Getting started Barebones can be downloaded via zip file or the repo can be cloned: -- [Download the zip](https://github.com/acahir/Barebones/archive/2.0.4.zip) +- [Download the zip](https://github.com/acahir/Barebones/archive/master.zip) - Clone the repo: `https://github.com/acahir/Barebones.git` -Note: The current master branch is simply v2.0.4 of Skeleton. Branch v3 is under active development. - - ### What's in the download? -The download includes Skeleton's CSS, Normalize CSS as a reset, a sample favicon, and an index.html as a starting point. +The download includes Skeleton's CSS, [Normalize CSS](https://github.com/necolas/normalize.css/) as a reset, a sample favicon, and an index.html as a starting point. It also includes skeleton-legacy.css in case you are updating an existing site, though this stylesheet is not linked in the index.html template. ``` Skeleton/ ├── index.html ├── css/ -│ ├── normalize.min.css -│ └── skeleton.css +│ ├── barebones.css +│ ├── normalize.css +│ └── skeleton-legacy.css └── images/ - └── favicon.ico + └── favicon.png ``` +## Why Barebones? + +Building off of Skeleton's [awesomeness](https://github.com/dhg/Skeleton#why-its-awesome): +- Updated to use CSS variables +- Uses CSS Grid to replace 12-column grid system +- Updated normalize to current version (3.0.2 -> 8.0.1) +- Maintains backwards compatibility with Skeleton + +Additional features planned and possible: +- Support for @media prefers-color-scheme (aka Dark Mode) +- Pending Release: Uses CSS env() function +- Include "extensions": instructions and templates for frequently used features: + - Navigation boilerplate + - Code formatting + - Smooth Scrolling +- Add additional example site demonstrating CSS Grid layout flexibility + + + + ## Browser support -- Chrome latest -- Firefox latest -- Opera latest -- Safari latest -- IE latest +Barebones does make use of modern CSS features, but the base functionality is well supported. -With the inclusion of CSS Grid, support for IE v11 and earlier is not included. Check [caniuse](https://caniuse.com/#feat=css-grid) for more details. While possible to include partial support for IE with -ms prefixes, it doesn't seem justified at this time. +- CSS Grid: [88% global browser support](https://caniuse.com/#feat=css-grid) +- CSS Variables: [87% global browser support](https://caniuse.com/#feat=css-variables) + +The most notable missing support for both features is from IE 11 or earlier. That's probably the browser that your decision will depend on. + +Barebones includes a few experimental features that are not yet widely supported. If not supported, the brower will simply ignore those directives: +- prefers-color-scheme media query: Only currently available in Safari Technology Preview +- scroll-behavior: Chrome, Firefox +- CSS env(): Nothing included in Barebones, but media queries were structured in such as way to make use of env() variables in the future +Both of these features can be achived using other methods. In fact, both are implemented using css and vanilla javascript on the [Barebones documentation page](https://acahir.github.io/Barebones/) in ~50 lines of code. In the future these may be added to Barebones as "extensions". + +#### External dependencies + +- normalize.css: Chrome, Edge, Firefox ESR+, Internet Explorer 10+, Safari 8+, Opera + + +## Acknowledgements + +Barebones is build upon the great work of the Skeleton project by [Dave Gamache](https://twitter.com/dhg). It wouldn't be possible without him, and Barebones only exists because Skeleton is no longer being maintained. + +The [documentation page](https://acahir.github.io/Barebones/) makes use of icons by [FontAwesome](https://fontawesome.com), [smoothscroll](https://github.com/iamdustan/smoothscroll) by [Dustan Kasten](https://github.com/iamdustan), [Google Prettify](https://code.google.com/p/google-code-prettify/), and other great tidbits shared by many. ## License diff --git a/css/normalize.css b/css/normalize.css old mode 100755 new mode 100644 diff --git a/images/favicon-16.png b/images/favicon-16.png new file mode 100644 index 0000000000000000000000000000000000000000..5f21e918c3fb6ea79696aa6535c9d4793059280f GIT binary patch literal 867 zcmV-p1DyPcP)daT^g-B@efp0i%C{$h1S0_^1z>o-=hpkgl8VC|FTC9gbW{lU5@ zus#oK;RC*w5-|V5sylqD4POgK<1J7A>LR!#4WDmVX9`&U4e&`4N+eb$=wP2dv%Z_? zvmX6^KgHv5z1y~h5Y%qB>Gt-P?(gsIeusw&_rGWTsgEOBBvYkLCXF#>U1h-*+H@GRhTse0-!@ z?TMCXAkheAWdrU+TldgOYsG$Y!&SJ{b>~wzzs7k47V5Iw_1M z3E9`N&43>cCnm^=R;x!qzTsrc_kiFlTAZAmh)^h`tT*@t)|8+mbF&h5A^{9w83kMM zPm59$i~m}dOG1c*o7(|j@VS&=pO7q$#VU_E?X&F1TKI6>a~_*3V2(38vu@;Z35phT tv1aaDPyR9C`7;H@E9ys-aIXD5{|)q%bTL5Ati1pL002ovPDHLkV1krUmUsXF literal 0 HcmV?d00001 diff --git a/images/favicon.png b/images/favicon.png deleted file mode 100644 index 7a3c81c1e32b4e4224452cf8261a585480caa0ea..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1156 zcmV-~1bh35P)Px(K1oDDR9FeUS6ygSR}lVo-6obMX;utd(pYw*xM;*axQ4d&FA%IGA~hPSg!&Re z%!{H3LD7)Nf>mf~DXa7+587b*Vq0rT+y^!IQ_&TXVq{}Xg2tsmWK$E{Rg$dV+}vF6 z#`_m=J8(F2&&-)`&YW}R%yq#z<@o*n3YW{ZhEo=^6_YQP>FIPj!A@E?`I7?!182!U zWwRxhod!YQaJ$|6s8`2UV5hIjAF*$nn3!mxGk;snv2q|c5D4ty$oVx(v2fUKIJzp%YyG-;+|bmTJITBB&Z-~d;>l)!%wq-3T*Hu{5vvj{FwB`QX)d;Q(oi9$K)StVkW z6c!eyhlhvdszTWU_0aWF=-{;b&=3w|^@mIFWhm}D9??d2iK8!I63Xsg){iGSF*2TdhFu$i_?LHwo`odIDct3 zl;>}naw>Tj*DjvJug8wyM9k^>l~=UK#Tzg}dsgRKg9|nMfVQ0#T)#Obt{lbsjm=KC zVN{<9&8@1ESY$JTRl9KNN*u|Qv3ha&CbWO;=u(M+wDT=6zzcm;gX)@ER92Rw`1u6^ zQrGcW*?Pnb=IDo*jCv#jQpq@?hQmh@t_x|pv91$n-nJ1Rl)Z;jcTGZ~X&W*LaiH5! zG<`7Cge@yqU_;B#h((X1slEn5pQ_|r0k7m_jb4F+oG#kkE+&IdSaNl0b4{3V^d>gw z648{}SSkh2Y<>K>1Mzm0RqdHlG41&@uX6K2kXK1+I7_;Js~2Mi8q>jn2l#QHJvdE0 z5^Q;n$C-@YV!zzLzBY8VvmM`_z722DTolcD9r>@y6QZXvB;s8-v}p~#%cyzuIvIRx zGMPN7yoNJ-j#VQ*A42oyVT4&EKYs-GVsWQ;U&{E*=U7ZKBepOj?#=KqOCNM#KPzP^ z^(PAw6-UbOb9CaRRKjMy6Z|s4Kc-wM)AgC~359DZkm@yCG^k=|{|I^qASDtNs)?Qr zC&XrzVCYw;976qo@am!bUw%xqs#xy?E7noApQL)_c!=j>`km9OoAQjN6bD~$&+BRL zA0tIW2UNvzDV^y=D; - + - + -
-
-
+
+

Basic Page

-

This index.html page is a placeholder with the CSS, font and favicon. It's just waiting for you to add some content! If you need some help hit up the Skeleton documentation.

+

This index.html page is a placeholder with the CSS, font and favicon. It's just waiting for you to add some content! If you need some help hit up the Barebones documentation.