Skip to content

Commit

Permalink
add a README
Browse files Browse the repository at this point in the history
  • Loading branch information
andydotxyz committed Feb 10, 2018
1 parent 9255e2c commit bd7d48d
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# About

[Fyne](http://fyne.io) is an easy to use UI toolkit and app API written in Go. We use the EFL render pipeline to provide cross platform graphics.

This is under heavy development and is not yet capable of supporting a full application

# Prerequisites

Before you can use the Fyne tools you need to have a stable copy of EFL installed. This will be automated by our [bootstrap](https://github.com/fyne-io/bootstrap/) scripts soon, but for now you need to install at least EFL 1.20 from your package manager or the [Enlightenment downloads](https://download.enlightenment.org/rel/libs/efl/) page.

# Getting Started

Using standard go tools you can install Fyne's core library using:

go get github.com/fyne-io/fyne

And then you're ready to write your first app - this example shows how:

package main

import "github.com/fyne-io/fyne/app"

func main() {
app.NewWindow("test")

app.Run()
}

And you can run that simply as:

go run main.go

0 comments on commit bd7d48d

Please sign in to comment.