photon README

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

Photon

Build Status

UI toolkit for building desktop apps with Electron.

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. You'll see something like this:

photon/
├── css/
│   ├── photon.css
├── fonts/
│   ├── photon-entypo.eot
│   ├── photon-entypo.svg
│   ├── photon-entypo.ttf
│   └── photon-entypo.woff
└── template-app/
    ├── js/
    │   └── menu.js
    ├── app.js
    ├── index.html
    └── package.json

We provide compiled CSS (photon.*). We also include the Entypo fonts and a template Electron application for you to quickly get started.

Documentation

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

Running documentation locally

  1. If necessary, install Jekyll (requires v2.5.x).
  1. Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
  2. From the root /photon 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.

Contributing

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

Development

  1. Install node dependencies: npm install.
  2. Open the example app: npm start.

Modifying source Sass files? Open a second Terminal tab and run npm run build to kick off a build of the compiled photon.css.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Photon 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

License

Copyright @connors. Released under MIT.

photon (connors/photon)

Searching Database…

10.1K ·GitHub
Photon
这是什么？Photon 是一个用于开发桌面应用的 UI 工具包，配合 Electron 使用：你直接用普通 HTML 和 CSS 设计应用界面，同时可以使用它提供的现成样式和组件。
这是一个完整的框架，还是只是放进项目里就能用的样式表？它是一套 CSS UI 套件，而不是应用生成器：下载包里包含编译好的 CSS（photon.css）、Entypo 字体，以及一个可以起步用的 Electron 模板应用。
我该怎么用它把应用跑起来？先用 git clone 克隆仓库，再阅读文档了解各个组件；仓库里自带一个 Electron 模板应用，用 npm start 就能启动。要获取稳定的代码，请使用带版本标签的下载包。
使用它需要安装什么？需要安装 Node.js 和 Electron 才能运行自带的模板应用，因为 npm start 是通过 electron 来启动它的；这套工具本身只是 CSS 和字体，由你的应用引用。
克隆之前有什么需要注意的吗？有：master 是活跃且不稳定的开发分支，所以请从带版本标签的下载包获取稳定版本，不要直接在 master 上开发。
Photon 可以免费在我自己的应用里使用吗？可以，它采用 MIT 许可证发布，无论个人还是商业 Electron 应用都可以自由使用。
Photon 的下载包里具体包含哪些东西？包含编译好的样式表（photon.css）、Entypo 字体，以及一个帮助你快速启动自己应用的 Electron 模板应用。
组件文档放在哪里？文档使用 Jekyll 构建，公开托管在 GitHub Pages 上；README 会引导你去那里学习各组件的用法，并开始开发你的新应用。
What are similar projects?materialize, mdb-ui-kit, uikit, bulma, weui, milligram, daisyui, Semantic-UI
Which topics is it in?css-framework, ui-kit, electron-app, design, electron, css, developers, html, ui, framework, desktop-app, frontend
Creator
connors
Size
3.1 MB
Stars
10.1K
Updated
CommitFeb 24
Age
11y
Commits · 90 Days