Skip to content

Commit

Permalink
Remove extra references to freetype
Browse files Browse the repository at this point in the history
  • Loading branch information
rayzchen committed Jun 8, 2024
1 parent 03ee09b commit 6a83a31
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
3to4++
*.exe
*.dll
*.lib
.vscode/
3to4pp/
include/GLFW/
Expand Down
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# 3to4++ v1.1

A virtual simulator for the [physical 3x3x3x3 design](https://hypercubing.xyz/puzzles/physical/3x3x3x3/) by Grant S.
Written with [GLFW](https://www.glfw.org/), [FreeType](https://freetype.org/), [OpenGL](https://www.opengl.org/) and [C++](https://isocpp.org/).
Written with [GLFW](https://www.glfw.org/), [Dear ImGui](https://github.com/ocornut/imgui), [OpenGL](https://www.opengl.org/) and [C++](https://isocpp.org/).
Credit to [Akkei's physical 3^4 program](https://hypercubing.xyz/software/#other) for inspiration and design.

## Download

For Windows only: https://github.com/rayzchen/3to4pp/releases/latest

## Compiling

On Linux, install a C++ compiler, `make`, the required GLFW, freetype and OpenGL dev packages.
### Linux

On Linux, install a C++ compiler, `make`, the required GLFW and OpenGL dev packages.

Then run
```
Expand All @@ -16,11 +22,11 @@ $ ./3to4++
```
to compile and run. If `make shared` fails, try `make build`.

On Windows, install [MinGW](https://www.mingw-w64.org/) or [Cygwin](https://www.cygwin.com/index.html) for a GNU C++ compiler.
### Windows

Next, go to https://www.glfw.org/download.html, select Windows binaries for the correct architecture. In the zip, copy all files under `lib-mingw-w64/` into this repo's `lib/` folder, and copy `include/GLFW/` into this repo's `include/` folder.
On Windows, install [MinGW](https://www.mingw-w64.org/) and [Git for Windows](https://gitforwindows.org/), or [Cygwin](https://www.cygwin.com/index.html). This will setup a GNU C++ compiler and `make` system.

Then go to https://freetype.org/download.html and build using `./configure` and `make`. Copy the header files and generated `libfreetype.a` file into `include/` and `lib/` respectively.
Next, go to https://www.glfw.org/download.html, select Windows binaries for the correct architecture. In the zip, copy all files under `lib-mingw-w64/` into this repo's `lib/` folder, and copy `include/GLFW/` into this repo's `include/` folder.

Finally run
```
Expand Down

0 comments on commit 6a83a31

Please sign in to comment.