From af03253213dacdd724b353a27995bcd9d1639a29 Mon Sep 17 00:00:00 2001 From: Allen Ray Date: Thu, 2 Sep 2021 11:55:37 -0400 Subject: [PATCH] Updated Readme --- README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/README.md b/README.md index 5ba4b7a..ab693e7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,6 @@ -# WIP PixelUI -**This repository is a proof of concept right now and is not very usable right now.** +# PixelUI Adds GUIs to the [Pixel](https://github.com/faiface/pixel) rendering engine by interpreting [imgui-go](https://github.com/inkyblackness/imgui-go) render data into Pixel render calls. -# Temporary Installation Instructions -There are a couple changes to Pixel that are required for PixelUI to work well; until they're accepted into the project, to use PixelUI you'll have to follow these steps. -1. `go get github.com/faiface/pixel` and `go get github.com/dusk125/pixelui@gltriangles`. -2. cd into the pixel directory and run `git remote add pixelui git@github.com:dusk125/pixel.git`; this will add my fork of the Pixel project that contains the in-progress changes to allow PixelUI to work efficiently. -3. Still in the pixel directory, run `git fetch` then `git checkout -b pixelui pixelui/pixelui`; these commands to fetch my forks content and change the Pixel content to pull from my fork (while still allowing importing from github.com/faiface/pixel in GoLang). - -After those steps, you should be able to build a project using PixelUI, see the examples repository (look at the example on the gltriangles branch!). - -# API -Since this is a work in progress, the API is likely to change at any time until we can fix the issues in Broken Things. - # [Examples](https://github.com/dusk125/pixelui_examples) The [examples](https://github.com/dusk125/pixelui_examples) repository contains an example demonstrating PixelUI's functionality.