|
| 1 | +# HTML5 Boilerplate Template for Espresso |
| 2 | + |
| 3 | +The un-official H5BP website boilerplate template for Espresso (espressoapp.com) |
| 4 | +, the macOS Editor App. |
| 5 | + |
| 6 | +**_[Espresso][espressoapp] are the original authors of this template, I have |
| 7 | +simply taken what they have provided in the application already and upgraded it |
| 8 | +to use all of the latest projects. I found the bundled version was too outdated |
| 9 | +and needed upgrading/maintaining._** |
| 10 | + |
| 11 | +###### Table of Contents |
| 12 | + |
| 13 | +- [What is Included](#what-is-included) |
| 14 | + - [Vendor Scripts](#vendor-scripts) |
| 15 | + - [Theme Templates](#theme-templates) |
| 16 | + - [Theme Options](#theme-options) |
| 17 | +- [Getting Started](#getting-started) |
| 18 | + - [Prerequisites](#prerequisites) |
| 19 | + - [Installing](#installing) |
| 20 | + - [In Espresso](#in-espresso) |
| 21 | + - [Via Terminal](#via-terminal) |
| 22 | +- [Contributing](#contributing) |
| 23 | +- [Code of Conduct](#code-of-conduct) |
| 24 | +- [Versioning](#versioning) |
| 25 | +- [Change-Log](#change-log) |
| 26 | +- [Authors](#authors) |
| 27 | +- [License](#license) |
| 28 | +- [Acknowledgements](#acknowledgements) |
| 29 | + |
| 30 | +## What is Included |
| 31 | + |
| 32 | +The following come included in this template for `Espresso`. |
| 33 | + |
| 34 | +### Vendor Scripts |
| 35 | + |
| 36 | +The following vendor scripts are included in the template and have all been |
| 37 | +upgraded from their original versions. |
| 38 | + |
| 39 | +1. [Bootstrap 3.3.7][bootstrap] - from version 3.1.1 |
| 40 | +2. [jQuery 3.3.1][jquery] - from version 1.11.0 |
| 41 | +3. [Modernizr 3.6.0][modernizr] - from version 2.6.2 |
| 42 | +4. [Respond.js 1.4.2][respond] - from version 1.1.0 |
| 43 | +5. [html5shiv 3.7.3][html5shiv] - from version 3.6 |
| 44 | + |
| 45 | +### Theme Templates |
| 46 | + |
| 47 | +H5BP website boilerplate template for Espresso has also been upgrade from |
| 48 | +version 4.6.0 to version 6.1.0. The template includes the following three |
| 49 | +variations: |
| 50 | + |
| 51 | +1. Blank HTML5 starter template with only jQuery included. |
| 52 | +2. Responsive starter template with jQuery and Respond.js. |
| 53 | +3. Bootstrap Jumbotron template with jQuery and Respond.js. |
| 54 | + |
| 55 | +You have the choice of either `Modernizr` or `html5shiv` as the HTML5 fallback |
| 56 | +with each of the three options above. |
| 57 | + |
| 58 | +### Theme Options |
| 59 | + |
| 60 | +The following screenshot outlines the various options available to you when you |
| 61 | +create a _New Project_ within `Espresso`. |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | +## Getting Started |
| 66 | + |
| 67 | +These instructions will get the H5BP template installed on your macOS machine. |
| 68 | + |
| 69 | +### Prerequisites |
| 70 | + |
| 71 | +You will need a copy of [Espresso][espressoapp] running on `macOS`. |
| 72 | + |
| 73 | +### Installing |
| 74 | + |
| 75 | +There are two methods to installing this template and these are documented |
| 76 | +below. |
| 77 | + |
| 78 | +#### In Espresso |
| 79 | + |
| 80 | +- Download the template by [clicking this link][code]. |
| 81 | +- Extract the zip folder. |
| 82 | +- Open up your `Espresso.app` application on your machine. |
| 83 | +- Click `File` -> `New Project` |
| 84 | + (or <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>N</kbd>) |
| 85 | +- Click `Show Templates Folder` |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +- Copy the extracted folder (called `H5BP.espressotemplate`) to the `Templates` |
| 90 | + directory that has just opened up. |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | +The new template should now be available for you to use in the `Espresso` app: |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | +#### Via Terminal |
| 99 | + |
| 100 | +- Open up your `Terminal.app` application on your machine. |
| 101 | +- Run the following commands to checkout the project directly to your |
| 102 | + `Templates` folder: |
| 103 | + |
| 104 | +```terminal |
| 105 | +$ cd ~/Library/Application\ Support/Espresso/Templates/ |
| 106 | +$ git clone https://github.com/justinhartman/H5BP.espressotemplate.git |
| 107 | +``` |
| 108 | + |
| 109 | +You can now open up `Espresso.app` and the template will be available to you |
| 110 | +when you click on `New Project`. |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +## Contributing |
| 115 | + |
| 116 | +Please read the [CONTRIBUTING.md][CONTRIBUTING] file for details on how you |
| 117 | +can get involved in the project as well as the process for submitting bugs |
| 118 | +and pull requests. |
| 119 | + |
| 120 | +## Code of Conduct |
| 121 | + |
| 122 | +Please read the [CODE_OF_CONDUCT.md][COC] file for the guidelines that govern |
| 123 | +the community. |
| 124 | + |
| 125 | +## Versioning |
| 126 | + |
| 127 | +We use [Semantic Versioning][semver] for software versions of this project. |
| 128 | +For a list of all the versions available, see the [tags][tags] and |
| 129 | +[releases][releases] on this repository. |
| 130 | + |
| 131 | +## Change-Log |
| 132 | + |
| 133 | +View the [CHANGELOG.md][changelog] file for a detailed list of changes, |
| 134 | +along with specific tasks completed for each version released to date. |
| 135 | + |
| 136 | +## Authors |
| 137 | + |
| 138 | +- Justin Hartman - [@justinhartman][author-1] |
| 139 | + |
| 140 | +Also see the list of [contributors][contribs] who have participated in this |
| 141 | +project. |
| 142 | + |
| 143 | +## License |
| 144 | + |
| 145 | +This project is licensed under the `MIT` License. See the |
| 146 | +[LICENSE][license] file for full details. |
| 147 | + |
| 148 | +## Acknowledgements |
| 149 | + |
| 150 | +Special thanks go out to the following people and projects. |
| 151 | + |
| 152 | +- [Espresso][espressoapp] - for the included template that this has been |
| 153 | + upgraded from. |
| 154 | +- [HTML5Boilerplate][h5bp] - for providing the boilerplates in this template. |
| 155 | +- [@justinhartman/.github][.github] - for the Github project templates. |
| 156 | + |
| 157 | +[//]: # (Make sure to change the URL links for `[tags]`, `[releases]`,) |
| 158 | +[//]: # (`[contribs]` and `[author-1]` below to your specific project.) |
| 159 | + |
| 160 | +[deploy]: #deployment |
| 161 | +[CONTRIBUTING]: CONTRIBUTING.md |
| 162 | +[COC]: CODE_OF_CONDUCT.md |
| 163 | +[license]: LICENSE |
| 164 | +[changelog]: CHANGELOG.md |
| 165 | +[semver]: http://semver.org |
| 166 | +[tags]: https://github.com/justinhartman/H5BP.espressotemplate/tags |
| 167 | +[releases]: https://github.com/justinhartman/H5BP.espressotemplate/releases |
| 168 | +[contribs]: https://github.com/justinhartman/H5BP.espressotemplate/contributors |
| 169 | +[author-1]: https://github.com/justinhartman |
| 170 | +[.github]: https://github.com/justinhartman/.github |
| 171 | +[espressoapp]: https://espressoapp.com "Espresso, the Mac Editor." |
| 172 | +[code]: https://github.com/justinhartman/H5BP.espressotemplate/archive/master.zip |
| 173 | +[h5bp]: https://html5boilerplate.com |
| 174 | +[bootstrap]: https://getbootstrap.com/docs/3.3/ |
| 175 | +[jquery]: https://jquery.com |
| 176 | +[modernizr]: https://modernizr.com |
| 177 | +[respond]: https://github.com/scottjehl/Respond |
| 178 | +[html5shiv]: https://github.com/aFarkas/html5shiv |
0 commit comments