28 lines
1.2 KiB
Markdown
28 lines
1.2 KiB
Markdown
# Waves
|
|
|
|
Click effect inspired by Google's Material Design
|
|
http://fian.my.id/Waves/
|
|
|
|
## Documentation
|
|
|
|
Waves using [Situs](https://github.com/fians/situs) to generate documentation. Here are some steps to run documentation locally on your computer,
|
|
|
|
1. Make sure [Node.js](http://nodejs.org/) and [Ruby](https://www.ruby-lang.org/en/) installed in your computer.
|
|
2. Install SASS via RubyGems (`gem install sass`).
|
|
3. Install Situs globally via npm (`npm install situs -g`).
|
|
4. Clone Waves's Github repository, if you haven't already (`git clone https://github.com/fians/Waves.git`).
|
|
5. Run `npm install` to install the necessary local node packages.
|
|
6. Install grunt globally with `npm install -g grunt-cli`.
|
|
7. Run `grunt` to watch the directory, or simply `grunt build` to do a single build.
|
|
8. Now just start Situs server (`situs server`), then visit [http://localhost:4000/](http://localhost:4000/) on your browser.
|
|
|
|
## Notes
|
|
|
|
Thanks for [BrowserStack](http://www.browserstack.com/) by providing a great testing tools for this projects.
|
|
|
|
|
|
## License
|
|
Waves created by [Alfiana Sibuea](http://fian.my.id), and released under [MIT license](https://github.com/fians/Waves/blob/master/LICENSE).
|
|
|
|
Copyright © 2014 Alfiana E. Sibuea. All rights reserved.
|