Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
astrofra authored Aug 5, 2023
1 parent 96965e7 commit 9bba959
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Harfang GUI
# Harfang UI

**Harfang GUI** is a _immediate mode_ GUI library built on top of HARFANG® 3D.
**Harfang UI** is a _immediate mode_ GUI library built on top of HARFANG® 3D.
It supports 2D, 3D & VR (wip).<br>
Harfang GUI was created by [Eric Kernin](https://github.com/ErkMkd)

Expand Down Expand Up @@ -34,15 +34,16 @@ The current version of the Harfang GUI API provides the following widgets:
- Slider float
- Widgets group

## How to use Harfang GUI?
## How to use Harfang UI?

>Please check the code samples to see how to use the library.<br>
See the `samples/` folder.

## How to run the samples?

1. Download the [wheel package](https://github.com/harfang3d/harfang-gui/releases)
2. Clone this repository `git clone https://github.com/harfang3d/harfang-gui.git`
3. Open the local repository in VSCode
4. Run the samples found in `samples/`
- :warning: The first run might be a bit long, as the graphic assets need to be compiled.
1. Install Harfang UI : `pip install harfangui-2.0.0-py3-none-any.whl`
1. Clone this repository : `git clone https://github.com/harfang3d/harfang-gui.git`
1. Open the local repository in VSCode
1. Run the samples found in `samples/`
- :warning: The first run might be a bit long, as the graphic assets need to be compiled.

0 comments on commit 9bba959

Please sign in to comment.