Reorg and prep for alpha release (#432)
This commit is contained in:
34
README.md
34
README.md
@@ -4,6 +4,36 @@ The internet's most popular icon toolkit is being redesigned and built from scra
|
||||
|
||||
Not familiar with Font Awesome 5? [Learn more](https://www.kickstarter.com/projects/232193852/font-awesome-5) about our successful Kickstarter and plan. You can also **[pre-order your copy of Font Awesome Pro](http://five.fontawesome.io/)** and save off of the release price.
|
||||
|
||||
## 5.0.0-alpha1 release
|
||||
|
||||
Download Font Awesome 5 Pro preview release:
|
||||
|
||||
* [For Mac](https://github.com/FortAwesome/Font-Awesome-Pro/releases/download/5.0.0-alpha1/fontawesome-5.0.0-alpha1-mac.zip)
|
||||
* [For Linux](https://github.com/FortAwesome/Font-Awesome-Pro/releases/download/5.0.0-alpha1/fontawesome-5.0.0-alpha1-linux.zip)
|
||||
* [For Windows](https://github.com/FortAwesome/Font-Awesome-Pro/releases/download/5.0.0-alpha1/fontawesome-5.0.0-alpha1-win.zip)
|
||||
|
||||
After you unzip the file run the following command in a terminal or shell for Mac of Linux:
|
||||
|
||||
```shell
|
||||
$ cd fontawesome-5.0.0-alpha1-mac
|
||||
$ ./demo
|
||||
```
|
||||
|
||||
Windows users:
|
||||
|
||||
```shell
|
||||
C:\Users\myusername\fontawesome-5.0.0-alpha1-win>demo.exe
|
||||
```
|
||||
|
||||
This launches a local web server that will give you easy access to the documentation for this release.
|
||||
|
||||
```shell
|
||||
Launching the demo application for Font Awesome 5
|
||||
Open your browser and visit http://localhost:3344
|
||||
|
||||
Press CTRL+C to stop the server
|
||||
```
|
||||
|
||||
## Project Progress
|
||||
Keep track of our progress through this project's [change log](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CHANGELOG.md). Want to keep up with what's planned for Font Awesome Pro? Check out [our milestones](https://github.com/FortAwesome/Font-Awesome-Pro/milestones?direction=asc&sort=due_date&state=open).
|
||||
|
||||
@@ -27,10 +57,6 @@ We'll use the following tools to design and produce icons:
|
||||
* Inkscribe
|
||||
* SVGO for optimization
|
||||
|
||||
### SVG Framework
|
||||
|
||||
Work for the new SVG Framework will be taking place inside the `svg-framework` directory. Go there now, [it's got its own README](https://github.com/FortAwesome/Font-Awesome-Pro/tree/master/svg-framework).
|
||||
|
||||
## Contributing
|
||||
Contributions, in code and constructive feedback, are very welcome. Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CONTRIBUTING.md).
|
||||
Included are directions for opening issues, coding standards, and community expectations.
|
||||
|
||||
Reference in New Issue
Block a user