ratchet README

The project's README from github.com/twbs/ratchet. As one markdown file: README.md.

Ratchet

GitHub Release Build Status devDependency Status

Build mobile apps with simple HTML, CSS, and JS components.

Table of contents

Getting started

Take note that our master branch is our active, unstable development branch and that if you're looking to download a stable copy of the repo, check the tagged downloads.

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

ratchet/
├── css/
│   ├── ratchet.css
│   ├── ratchet.min.css
│   ├── ratchet-theme-android.css
│   ├── ratchet-theme-android.min.css
│   ├── ratchet-theme-ios.css
│   └── ratchet-theme-ios.min.css
├── js/
│   ├── ratchet.js
│   └── ratchet.min.js
└── fonts/
    ├── ratchicons.eot
    ├── ratchicons.svg
    ├── ratchicons.ttf
    └── ratchicons.woff

We provide compiled CSS and JS (ratchet.*), as well as compiled and minified CSS and JS (ratchet.min.*). The Ratchicon fonts are included, as are the optional Android and iOS platform themes.

Documentation

Ratchet's documentation is built with Jekyll and publicly hosted on GitHub Pages at http://goratchet.com. The docs may also be run locally.

Running documentation locally

  1. If necessary, install Jekyll (requires v3.0.x).
  1. Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
  2. From the root /ratchet directory, run jekyll serve in the command line.
  3. Open http://localhost:4000 in your browser, and boom!

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

Documentation for v1.0.2 has been made available for the time being at http://goratchet.com/1.0.2/ while folks transition to Ratchet 2.

Previous releases and their documentation are also available for download.

Support

Questions or discussions about Ratchet should happen in the Google group or hit us up on Twitter @GoRatchet.

Contributing

Please file a GitHub issue to report a bug. When reporting a bug, be sure to follow the contributor guidelines.

Troubleshooting

A small list of "gotchas" is provided below for designers and developers starting to work with Ratchet.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Ratchet is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

For more information on SemVer, please visit http://semver.org/.

Maintainers

Connor Sears

Created by Connor Sears, Dave Gamache, and Jacob Thornton.

License

Ratchet is licensed under the MIT License.

ratchet (twbs/ratchet)

Searching Database…

14.7K ·GitHub
Что это?Ratchet — это фронтенд-фреймворк для создания прототипов мобильных приложений, который использует только компоненты на HTML, CSS и JavaScript.
Это фреймворк или библиотека?Это фреймворк компонентов на CSS и JS, похожий по духу на Bootstrap, но ориентированный на прототипирование интерфейсов в мобильном стиле, а не на полноценный набор инструментов для нативных приложений.
Как начать с ним работать?Склонируйте репозиторий командой git или скачайте входящие в комплект скомпилированные CSS и JS, затем изучите документацию, чтобы создать прототип и открыть его на телефоне.
Нужны ли мне какие-то инструменты сборки, чтобы им пользоваться?Для базового использования инструменты сборки не нужны, так как в загрузку включены скомпилированные и минифицированные файлы CSS/JS (ratchet.*, ratchet.min.*); Node >=0.10.1 понадобится только если вы хотите запускать тестовые задачи grunt из исходников.
Можно ли использовать ветку master в продакшене?Нет, master — это активная нестабильная ветка разработки; для стабильной копии лучше использовать загрузки с тегами и релизы.
Подходит ли он и для интерфейса в стиле iOS, и для интерфейса в стиле Android?Да, в комплект входят необязательные файлы тем оформления для внешнего вида как Android, так и iOS.
Какой набор шрифтов или иконок он включает?В комплект входит шрифт иконок Ratchicon вместе со скомпилированными CSS и JS.
Как собирается и публикуется документация?Документация собирается с помощью Jekyll и публично размещается на GitHub Pages.
Как Ratchet управляет версиями?Он следует семантическому версионированию: мажорные версии для несовместимых изменений, минорные для добавлений с сохранением обратной совместимости и патч-версии для исправлений ошибок.
Creator
twbs
Size
14.3 MB
Stars
14.7K
Age
14y
Commits · 90 Days