FlandreScarle7/Fork-Awesome
1
0
Fork 0
mirror of https://github.com/ForkAwesome/Fork-Awesome.git synced 2024-12-26 05:21:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adds link to Get Started in README and improve CDN tutorial

Browse Source
This commit is contained in:
Julien Deswaef 2018-03-07 16:57:40 -05:00
parent 6ff0fda509
commit 74d88fb8dc
3 changed files with 37 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -9,6 +9,9 @@ A tremendous gratitude is given to the whole team behind [Font Awesome](https://
Though If you believe in distributed open source design and wish to be part of this new adventure, please start submitting patches and suggestions of improvement.
## How to use
There is a full page in our documentation website that explains [how to use Fork Awesome in your web project](http://forkawesome.github.com/Fork-Awesome/get-started/). It ranges from just pointing to a CSS file on a CDN, hosting it on your own server or even adapting the LESS and SCSS files to your own liking.
## License
- The Fork Awesome font is licensed under the SIL OFL 1.1:
- http://scripts.sil.org/OFL
@ -32,8 +35,8 @@ with the following format:
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes, changes to brand logos, and misc changes bumps the patch
* Big changes, without breaking backward compatibility, bumps the minor (and resets the patch)
* Bug fixes, small adaptations, adding a few icons and misc changes bumps the patch
* The fork started from FontAwesome 4.7 (last commit by Dave is [bdfa9823](https://github.com/ForkAwesome/Fork-Awesome/commits/master?after=b0bc8f6fb74e05c987ef7ce1525cd3ab8390a1c3+69)).
* The project starts at version 1.0.0. All references to versions before the fork are named 0.4.7
@ -84,3 +87,7 @@ Or serve it on a local server on http://localhost:7998/Fork-Awesome/:
To deploy the project and documentation on GH pages:
$ jgd -n
## Badges
[![](https://data.jsdelivr.com/v1/package/npm/fork-awesome/badge)](https://www.jsdelivr.com/package/npm/fork-awesome)

11
src/doc/README.md-nobuild
View File

@ -11,6 +11,9 @@ A tremendous gratitude is given to the whole team behind [Font Awesome](https://
Though If you believe in distributed open source design and wish to be part of this new adventure, please start submitting patches and suggestions of improvement.
## How to use
There is a full page in our documentation website that explains [how to use {{ site.forkawesome.name }} in your web project]({{ site.forkawesome.url}}get-started/). It ranges from just pointing to a CSS file on a CDN, hosting it on your own server or even adapting the LESS and SCSS files to your own liking.
## License
- The {{ site.forkawesome.name }} font is licensed under the SIL OFL 1.1:
- http://scripts.sil.org/OFL
@ -34,8 +37,8 @@ with the following format:
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes, changes to brand logos, and misc changes bumps the patch
* Big changes, without breaking backward compatibility, bumps the minor (and resets the patch)
* Bug fixes, small adaptations, adding a few icons and misc changes bumps the patch
* The fork started from FontAwesome 4.7 (last commit by Dave is [bdfa9823](https://github.com/ForkAwesome/Fork-Awesome/commits/master?after=b0bc8f6fb74e05c987ef7ce1525cd3ab8390a1c3+69)).
* The project starts at version 1.0.0. All references to versions before the fork are named 0.4.7
@ -86,3 +89,7 @@ Or serve it on a local server on http://localhost:7998/Fork-Awesome/:
To deploy the project and documentation on GH pages:
$ jgd -n
## Badges
[![](https://data.jsdelivr.com/v1/package/npm/fork-awesome/badge)](https://www.jsdelivr.com/package/npm/fork-awesome)

35
src/doc/get-started.html
View File

@ -11,6 +11,24 @@ relative_path: ../
{% include jumbotron.html %}
<div class="container">
<section class="get-started-CDN margin-top-lg" id="get-started-CDN">
<h2 class="page-header clearfix">
Use a CDN for {{ site.forkawesome.name }}
<span class="label label-default text-base pull-right">simple</span>
</h2>
<div class="row">
<div class="col-md-12">
<p>The simplest way to get {{ site.forkawesome.name }} in your project is to copy the line below in between the <code>&lt;head&gt;</code> tags of your HTML source files. Then check the <a href="{{ page.relative_path }}examples/">examples</a> to start displaying icons.
<p>
{% highlight html %}
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@{{ site.forkawesome.version }}/css/fork-awesome.min.css" integrity="{% sri_hash css/fork-awesome.min.css %}" crossorigin="anonymous">
{% endhighlight %}
</p>
<p>Thanks to <a href="https://www.jsdelivr.com/package/npm/fork-awesome">jsDelivr</a> for providing the CDN for {{ site.forkawesome.name }}</p>
</div>
</div>
</section>
<section class="get-started-download" id="get-started-download">
<h2 class="page-header clearfix">
@ -38,7 +56,7 @@ relative_path: ../
<h3>Using CSS</h3>
<ol>
<li>Copy the entire <code>font-awesome</code> directory into your project.</li>
<li>Copy the entire <code>fork-awesome</code> directory into your project.</li>
<li>
In the <code>&lt;head&gt;</code> of your html, reference the location to your font-awesome.min.css.
{% highlight html %}
@ -69,21 +87,6 @@ relative_path: ../
</div>
</section>
<section class="get-started-CDN margin-top-lg" id="get-started-CDN">
<h2 class="page-header">Using {{ site.forkawesome.name }} with a CDN</h2>
</section>
<div class="row">
<div class="col-md-12">
<p>Thanks to <a href="https://www.jsdelivr.com">jsDelivr</a>, {{ site.forkawesome.name }} is available via a CDN as well.</p>
<p>
{% highlight html %}
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@{{ site.forkawesome.version }}/css/fork-awesome.min.css" integrity="{% sri_hash css/fork-awesome.min.css %}" crossorigin="anonymous">
{% endhighlight %}
</p>
</div>
</div>
<section class="get-started-more margin-top-lg" id="get-started-more">
<h2 class="page-header">More Information</h2>
</section>