aluminum
v0.3.4
Published
Painless native web applications.
Downloads
29
Readme
Aluminum
Aluminum makes it easy to create cross-platform native applications for Mac OS X, Windows, and Linux using HTML, CSS, and CoffeeScript.
Note: Aluminum is still in development. The documentation may reflect a version of Aluminum that is ahead of the actual implementation.
Installation
Install the Aluminum command-line utility:
npm install -g aluminum-cli
Install Aluminum in an existing project: (al init
does this for you)
npm install aluminum
Getting started
Create a directory for your project and initialize an empty app there:
mkdir ~/Projects/Hello
cd ~/Projects/Hello
al init
Follow the prompts to create your app's package.json
manifest.
name: (Hello)
version: (0.0.0)
description: Hello world app made with Aluminum.
entry point: (main.js)
icon:
Next, create an HTML file called main.html
for the main window:
<!doctype html>
<title>Hello</title>
<h1>Hello, world!</h1>
and a CoffeeScript file called main.coffee
:
{App, Window} = require "aluminum"
class MainWindow extends Window
path: "main.html" # the window's HTML content
class module.exports extends App
init: -> MainWindow.create() # create and show an instance of the main window
Run your app with al run
.
Check out the examples for more sample applications.