Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Allen Ray committed Sep 2, 2021
1 parent c85f65f commit af03253
Showing 1 changed file with 1 addition and 13 deletions.
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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.

Expand Down

0 comments on commit af03253

Please sign in to comment.