mirror of
https://github.com/FortAwesome/Font-Awesome.git
synced 2024-12-27 14:01:30 +08:00
updating config to new version, automating README.md better
This commit is contained in:
Dave Gandy
parent
be925ab85d
commit
cf3ebc280a
14
README.md
14
README.md
@ -1,8 +1,9 @@
|
||||
#[Font Awesome v4.1.0](http://fontawesome.io)
|
||||
#[Font Awesome v4.2.0](http://fontawesome.io)
|
||||
###The iconic font and CSS framework
|
||||
|
||||
Font Awesome is a full suite of 439 pictographic icons for easy scalable vector graphics on websites, created and
|
||||
maintained by [Dave Gandy](http://twitter.com/davegandy). Stay up to date [@fontawesome](http://twitter.com/fontawesome).
|
||||
Font Awesome is a full suite of 439 pictographic icons for easy scalable vector graphics on websites,
|
||||
created and maintained by [Dave Gandy](http://twitter.com/davegandy).
|
||||
Stay up to date [@fontawesome](http://twitter.com/fontawesome).
|
||||
|
||||
Get started at http://fontawesome.io!
|
||||
|
||||
@ -30,14 +31,17 @@ Get started at http://fontawesome.io!
|
||||
- [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed)
|
||||
- [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed)
|
||||
- [v4.1.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=6&page=1&state=closed)
|
||||
- [v4.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=12&page=1&state=closed)
|
||||
|
||||
## Contributing
|
||||
|
||||
Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
|
||||
Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome/blob/master/CONTRIBUTING.md).
|
||||
Included are directions for opening issues, coding standards, and notes on development.
|
||||
|
||||
##Versioning
|
||||
|
||||
Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:
|
||||
Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
|
||||
with the following format:
|
||||
|
||||
`<major>.<minor>.<patch>`
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ pygments: true
|
||||
permalink: pretty
|
||||
|
||||
# ensures SCSS files are compiled
|
||||
include: [_bordered-pulled.scss, _core.scss, _fixed-width.scss, _icons.scss, _larger.scss, _list.scss, _mixins.scss, _path.scss, _rotated-flipped.scss, _spinning.scss, _stacked.scss, _variables.scss]
|
||||
include: [_*.scss]
|
||||
|
||||
# used in building icon pages
|
||||
icon_meta: src/icons.yml
|
||||
@ -19,8 +19,8 @@ icon_layout: icon.html # Relative to _layouts directory
|
||||
icon_destination: icon # Relative to destination
|
||||
|
||||
fontawesome:
|
||||
version: 4.1.0
|
||||
minor_version: 4.1
|
||||
version: 4.2.0
|
||||
minor_version: 4.2
|
||||
url: http://fontawesome.io
|
||||
legacy_url: http://fortawesome.github.com/Font-Awesome/
|
||||
blog_url: http://blog.fontawesome.io
|
||||
@ -31,6 +31,7 @@ fontawesome:
|
||||
name: Dave Gandy
|
||||
email: dave@fontawesome.io
|
||||
twitter: davegandy
|
||||
github: davegandy
|
||||
github:
|
||||
url: https://github.com/FortAwesome/Font-Awesome
|
||||
project: Font-Awesome
|
||||
|
||||
6
css/font-awesome.css
vendored
6
css/font-awesome.css
vendored
@ -1,13 +1,13 @@
|
||||
/*!
|
||||
* Font Awesome 4.1.0 by @davegandy - http://fontawesome.io - @fontawesome
|
||||
* Font Awesome 4.2.0 by @davegandy - http://fontawesome.io - @fontawesome
|
||||
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
|
||||
*/
|
||||
/* FONT PATH
|
||||
* -------------------------- */
|
||||
@font-face {
|
||||
font-family: 'FontAwesome';
|
||||
src: url('../fonts/fontawesome-webfont.eot?v=4.1.0');
|
||||
src: url('../fonts/fontawesome-webfont.eot?#iefix&v=4.1.0') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff?v=4.1.0') format('woff'), url('../fonts/fontawesome-webfont.ttf?v=4.1.0') format('truetype'), url('../fonts/fontawesome-webfont.svg?v=4.1.0#fontawesomeregular') format('svg');
|
||||
src: url('../fonts/fontawesome-webfont.eot?v=4.2.0');
|
||||
src: url('../fonts/fontawesome-webfont.eot?#iefix&v=4.2.0') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff?v=4.2.0') format('woff'), url('../fonts/fontawesome-webfont.ttf?v=4.2.0') format('truetype'), url('../fonts/fontawesome-webfont.svg?v=4.2.0#fontawesomeregular') format('svg');
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
4
css/font-awesome.min.css
vendored
4
css/font-awesome.min.css
vendored
File diff suppressed because one or more lines are too long
2
less/font-awesome.less
vendored
2
less/font-awesome.less
vendored
@ -1,5 +1,5 @@
|
||||
/*!
|
||||
* Font Awesome 4.1.0 by @davegandy - http://fontawesome.io - @fontawesome
|
||||
* Font Awesome 4.2.0 by @davegandy - http://fontawesome.io - @fontawesome
|
||||
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
|
||||
*/
|
||||
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
// --------------------------
|
||||
|
||||
@fa-font-path: "../fonts";
|
||||
//@fa-font-path: "//netdna.bootstrapcdn.com/font-awesome/4.1.0/fonts"; // for referencing Bootstrap CDN font files directly
|
||||
//@fa-font-path: "//netdna.bootstrapcdn.com/font-awesome/4.2.0/fonts"; // for referencing Bootstrap CDN font files directly
|
||||
@fa-css-prefix: fa;
|
||||
@fa-version: "4.1.0";
|
||||
@fa-version: "4.2.0";
|
||||
@fa-border-color: #eee;
|
||||
@fa-inverse: #fff;
|
||||
@fa-li-width: (30em / 14);
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
// --------------------------
|
||||
|
||||
$fa-font-path: "../fonts" !default;
|
||||
//$fa-font-path: "//netdna.bootstrapcdn.com/font-awesome/4.1.0/fonts" !default; // for referencing Bootstrap CDN font files directly
|
||||
//$fa-font-path: "//netdna.bootstrapcdn.com/font-awesome/4.2.0/fonts" !default; // for referencing Bootstrap CDN font files directly
|
||||
$fa-css-prefix: fa !default;
|
||||
$fa-version: "4.1.0" !default;
|
||||
$fa-version: "4.2.0" !default;
|
||||
$fa-border-color: #eee !default;
|
||||
$fa-inverse: #fff !default;
|
||||
$fa-li-width: (30em / 14) !default;
|
||||
|
||||
2
scss/font-awesome.scss
vendored
2
scss/font-awesome.scss
vendored
@ -1,5 +1,5 @@
|
||||
/*!
|
||||
* Font Awesome 4.1.0 by @davegandy - http://fontawesome.io - @fontawesome
|
||||
* Font Awesome 4.2.0 by @davegandy - http://fontawesome.io - @fontawesome
|
||||
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
|
||||
*/
|
||||
|
||||
|
||||
@ -29,9 +29,9 @@ build:
|
||||
|
||||
lessc --yui-compress ${SITE_LESS} > ${SITE_CSS}
|
||||
cp -r ${FA_ROOT_DIRECTORY}/* ../
|
||||
mv README.md-nobuild ../README.md
|
||||
cd assets && mv font-awesome font-awesome-{{ site.fontawesome.version }} && zip -r9 font-awesome-{{ site.fontawesome.version }}.zip font-awesome-{{ site.fontawesome.version }} && mv font-awesome-{{ site.fontawesome.version }} font-awesome
|
||||
|
||||
|
||||
default: build
|
||||
|
||||
|
||||
|
||||
87
src/README.md-nobuild
Normal file
87
src/README.md-nobuild
Normal file
@ -0,0 +1,87 @@
|
||||
---
|
||||
---
|
||||
#[Font Awesome v{{ site.fontawesome.version }}]({{ site.fontawesome.url }})
|
||||
###The iconic font and CSS framework
|
||||
|
||||
Font Awesome is a full suite of {{ icons | size }} pictographic icons for easy scalable vector graphics on websites,
|
||||
created and maintained by [{{ site.fontawesome.author.name }}](http://twitter.com/{{ site.fontawesome.author.twitter }}).
|
||||
Stay up to date [@{{ site.fontawesome.twitter }}](http://twitter.com/{{ site.fontawesome.twitter }}).
|
||||
|
||||
Get started at {{ site.fontawesome.url }}!
|
||||
|
||||
##License
|
||||
- The Font Awesome font is licensed under the SIL OFL 1.1:
|
||||
- http://scripts.sil.org/OFL
|
||||
- Font Awesome CSS, LESS, and SASS files are licensed under the MIT License:
|
||||
- http://opensource.org/licenses/mit-license.html
|
||||
- The Font Awesome documentation is licensed under the CC BY 3.0 License:
|
||||
- http://creativecommons.org/licenses/by/3.0/
|
||||
- Attribution is no longer required as of Font Awesome 3.0, but much appreciated:
|
||||
- `Font Awesome by Dave Gandy - http://fontawesome.io`
|
||||
- Full details: http://fontawesome.io/license
|
||||
|
||||
##Changelog
|
||||
- v3.0.0 - all icons redesigned from scratch, optimized for Bootstrap's 14px default
|
||||
- v3.0.1 - much improved rendering in webkit, various bug fixes
|
||||
- v3.0.2 - much improved rendering and alignment in IE7
|
||||
- v3.1.0 - Added 54 icons, icon stacking styles, flipping and rotating icons, removed SASS support
|
||||
- [v3.1.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=4&page=1&state=closed)
|
||||
- [v3.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=3&page=1&state=closed)
|
||||
- [v3.2.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=5&page=1&state=closed)
|
||||
- [v4.0.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=2&page=1&state=closed)
|
||||
- [v4.0.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=7&page=1&state=closed)
|
||||
- [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed)
|
||||
- [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed)
|
||||
- [v4.1.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=6&page=1&state=closed)
|
||||
- [v4.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=12&page=1&state=closed)
|
||||
|
||||
## Contributing
|
||||
|
||||
Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome/blob/master/CONTRIBUTING.md).
|
||||
Included are directions for opening issues, coding standards, and notes on development.
|
||||
|
||||
##Versioning
|
||||
|
||||
Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
|
||||
with the following format:
|
||||
|
||||
`<major>.<minor>.<patch>`
|
||||
|
||||
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 and misc changes bumps the patch
|
||||
|
||||
For more information on SemVer, please visit http://semver.org.
|
||||
|
||||
##Author
|
||||
- Email: {{ site.fontawesome.author.email }}
|
||||
- Twitter: http://twitter.com/{{ site.fontawesome.author.twitter }}
|
||||
- GitHub: https://github.com/{{ site.fontawesome.author.github }}
|
||||
|
||||
##Component
|
||||
To include as a [component](http://github.com/component/component), just run
|
||||
|
||||
$ component install FortAwesome/Font-Awesome
|
||||
|
||||
Or add
|
||||
|
||||
"FortAwesome/Font-Awesome": "*"
|
||||
|
||||
to the `dependencies` in your `component.json`.
|
||||
|
||||
## Hacking on Font Awesome
|
||||
|
||||
From the root of the repository, install the tools used to develop.
|
||||
|
||||
$ bundle install
|
||||
$ npm install
|
||||
|
||||
Build the project and documentation:
|
||||
|
||||
$ bundle exec jekyll build
|
||||
|
||||
Or serve it on a local server on http://localhost:7998/Font-Awesome/:
|
||||
|
||||
$ bundle exec jekyll serve
|
||||
Loading…
Reference in New Issue
Block a user