artin/tachyons
1
0
Fork 0
mirror of https://github.com/tachyons-css/tachyons.git synced 2026-02-06 11:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Adam Morse 2014-10-09 14:30:12 -07:00
parent abce119e5e
commit ab2280e55d
1 changed files with 12 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -1,14 +1,14 @@
# TACHYONS
WIP (heavily in flux)
A performance-first css framework
Simple modules and components that move faster than the speed of light.
Single purpose classes that are extremely composable.
## Getting started
Set up the project by cloning the repo, navigating into it, then installing the necessary dependencies by running:
Set up the project by cloning the repo, navigating into it, and installing the necessary dependencies by running the following commands:
```
git clone git@github.com:mrmrs/tachyons.git yourProject
@ -16,45 +16,23 @@ Set up the project by cloning the repo, navigating into it, then installing the
rm -rf .git
git init
git add remote git@github.com/yourUserName/yourProject.git
npm install -g gulp
npm install .
npm install
```
### To run the development environment
Once you've run npm install just run this very complicated command in your terminal to start gulp
gulp
```
npm start
```
This will watch the sass directory and do the following on file change:
• Compile scss files down to css/i.css
• Run autoprefixer on css/app.css (this allows you to keep vendor prefixes out of your css)
• Compile scss files down to css/tachyons.css
• Run autoprefixer on css/tachyons.css (this allows you to keep vendor prefixes out of your css)
• Run csslint and spit the output to your terminal window where you are running gulp
• Run an instance of livereload. With the chrome and safari extensions, you can see
changes in the browser without hitting refresh
### To minify assets for production
gulp production
This will
• Compile scss files down to css/i.css
• Run autoprefixer on css/app.css (this allows you to keep vendor prefixes out of your css)
• Minify all css files and move them to in the ./css
• Compress / minify all images in the ./img directory
• Compress / minify all svg elements in the ./img/svg/ directory
• Run an instance of browser-sync - this causes any browsers or devices pointing to your local server to reload on file change.
## Perf Stats
This will be where I track performance benchmarks
### File sizes
```
i.css 53kb
i.min.css 36kb
gzipped 6.2kb
```
Coming soon...
## License