diff options
| author | Julien Deswaef <judeswae@thoughtworks.com> | 2018-04-30 01:51:04 +0300 |
|---|---|---|
| committer | Julien Deswaef <judeswae@thoughtworks.com> | 2018-04-30 01:51:04 +0300 |
| commit | 31a0b2156c748891ca0d18b00349b7647cf1f6b1 (patch) | |
| tree | a4e48c113ad8c78f4c0a0bd2f6c93f0a306e383d | |
| parent | 521bdd2f1e30273e23de16f26f538f20edda9b19 (diff) | |
Updates to the README
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | src/doc/README.md-nobuild | 5 |
2 files changed, 8 insertions, 7 deletions
@@ -1,11 +1,11 @@ # Fork Awesome ### A fork of the iconic font and CSS toolkit +[](CONTRIBUTORS.md) +[](https://www.jsdelivr.com/package/npm/fork-awesome) [](https://cdnjs.com/libraries/fork-awesome) -[](https://www.jsdelivr.com/package/npm/fork-awesome) -[](CONTRIBUTORS.md) -Fork Awesome is a full suite of 705 pictographic icons for easy scalable vector graphics on websites, originally created by [Dave Gandy](https://twitter.com/davegandy) and now maintained by a community. +Fork Awesome is a full suite of 717 pictographic icons for easy scalable vector graphics on websites, originally created by [Dave Gandy](https://twitter.com/davegandy) and now maintained by a community. Following concerns regarding [the development of Font Awesome](https://github.com/FortAwesome/Font-Awesome/issues/12199#issuecomment-362919956), the PR Freeze since Oct 2016 and the direction [Fort Awesome](https://fortawesome.com/) is taking with the version 5.0 of their project, we are forking Font Awesome (4.7), in order to build on this incredible tool Dave Gandy has given us, while at the same time allowing this project to be run by a distributed community of contributors. @@ -59,7 +59,7 @@ Or add to the `dependencies` in your `component.json`. -## Building on Fork Awesome +## Building Fork Awesome **Before you can build the project**, you must first have the following installed: @@ -84,7 +84,7 @@ Build the web documentation: $ npm run build -Or serve it on a local server (http://localhost:7998): +Or serve it on a local server on http://localhost:7998: $ npm run dev diff --git a/src/doc/README.md-nobuild b/src/doc/README.md-nobuild index 551835e66..0bb82083c 100644 --- a/src/doc/README.md-nobuild +++ b/src/doc/README.md-nobuild @@ -61,7 +61,7 @@ Or add to the `dependencies` in your `component.json`. -## Building on {{ site.forkawesome.name }} +## Building {{ site.forkawesome.name }} **Before you can build the project**, you must first have the following installed: @@ -69,6 +69,7 @@ to the `dependencies` in your `component.json`. - Ruby Development Headers - **Ubuntu:** `sudo apt-get install ruby-dev` *(Only if you're __NOT__ using `rbenv` or `rvm`)* - **Windows:** [DevKit](http://rubyinstaller.org/) + - **macOS:** no extra step required - [Bundler](http://bundler.io/) (Run `gem install bundler` to install). - [Node Package Manager (aka. `npm`)](https://docs.npmjs.com/getting-started/installing-node) @@ -85,7 +86,7 @@ Build the web documentation: $ npm run build -Or serve it on a local server on http://localhost:7998/Fork-Awesome/: +Or serve it on a local server on http://localhost:7998: $ npm run dev |