README
Omi Electron
Build cross platform desktop apps with Omi.js and Electron.js
基于Omi.js和Electron.js构建跨平台的桌面应用
Made with ❤︎ by Eno Yao
To Use
The latest stable download: Win Version | Source Code
The latest stable download: Mac Version | Source Code
将下载的压缩文件解压并并安装到系统中，双击应用图标启动应用，点击应用中间的绿色按钮，指定您的Omi项目的开发目录(一般是src文件夹下)，切换到你的编辑工具并在您项目的开发目录下创建或者编辑.omi后缀的文件，该文件会自动编译为.js文件
Unzip the downloaded compressed file and install it into the system. Double-click the application icon to start the application, click the green button in the middle of the application, select the development directory of your Omi project (usually under the src folder), switch to your IDE, and create or edit the file with the suffix of .omi under the development directory of your project. The file will be automatically compiled into .js file.
About Electron
Clone and run for a quick way to see Electron in action.
This is a minimal Electron application based on the Quick Start Guide within the Electron documentation.
Use this app along with the Electron API Demos app for API code examples to help you get started.
A basic Electron application needs just these files:
package.json- Points to the app's main file and lists its details and dependencies.main.js- Starts the app and creates a browser window to render HTML. This is the app's main process.index.html- A web page to render. This is the app's renderer process.
You can learn more about each of these components within the Quick Start Guide.
To Develop
1. The first method:
# Install this module from npm
npm install omie
# Go into the repository
cd node_modules/omie
# Install dependencies
npm install
# Run the app
npm start
2. The second method:
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
git clone https://github.com/Wscats/omi-electron
# Go into the repository
cd omi-electron
# Install dependencies
npm install
# Run the app
npm start
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
Resources for Learning Electron
- electronjs.org/docs - all of Electron's documentation
- electronjs.org/community#boilerplates - sample starter apps created by the community
- electron/electron-quick-start - a very basic starter Electron app
- electron/simple-samples - small applications with ideas for taking them further
- electron/electron-api-demos - an Electron app that teaches you how to use Electron
- hokein/electron-sample-apps - small demo apps for the various Electron APIs