Update README

This commit is contained in:
Alex Yatskov 2023-12-04 20:04:02 -08:00
parent dce6603c58
commit fcf3cced80

View File

@ -18,34 +18,34 @@ Lazarus is primarily being developed on Fedora, but the required package names a
1. Install the required packages (for [Fedora](https://getfedora.org/) users): 1. Install the required packages (for [Fedora](https://getfedora.org/) users):
``` ```
# dnf install golang gcc-c++ cmake make git SDL2-devel mesa-libGL-devel zlib-devel bzip2-devel sudo dnf install golang gcc-c++ cmake make git SDL2-devel mesa-libGL-devel zlib-devel bzip2-devel
``` ```
Install the required packages (for [Ubuntu](https://www.ubuntu.com/) users): Install the required packages (for [Ubuntu](https://www.ubuntu.com/) users):
``` ```
# apt-get install golang g++ cmake make git libsdl2-dev libgl1-mesa-dev zlib1g-dev libbz2-dev sudo apt-get install golang g++ cmake make git libsdl2-dev libgl1-mesa-dev zlib1g-dev libbz2-dev
``` ```
2. Build the [Dear ImGui](https://github.com/ocornut/imgui) wrapper package: 2. Build the [Dear ImGui](https://github.com/ocornut/imgui) wrapper package:
``` ```
$ go get github.com/FooSoft/lazarus/platform/imgui go get github.com/FooSoft/lazarus/platform/imgui
``` ```
Go will fetch the code, but Cgo will fail to link the [cimgui](https://github.com/cimgui/cimgui) wrapper; Go will fetch the code, but Cgo will fail to link the [cimgui](https://github.com/cimgui/cimgui) wrapper;
we need to configure and build it: we need to configure and build it:
``` ```
$ cd $GOPATH/src/github.com/FooSoft/lazarus/platform/imgui/cimgui cd $GOPATH/src/github.com/FooSoft/lazarus/platform/imgui/cimgui
$ cmake -DIMGUI_STATIC="yes" . cmake -DIMGUI_STATIC="yes" .
$ make make
``` ```
You should now have a `cimgui.a` statically linked library in the `cimgui` directory. You should now have a `cimgui.a` statically linked library in the `cimgui` directory.
3. Build the [StormLib](http://zezula.net/en/mpq/stormlib.html) wrapper package: 3. Build the [StormLib](http://zezula.net/en/mpq/stormlib.html) wrapper package:
``` ```
$ go get github.com/FooSoft/lazarus/formats/mpq go get github.com/FooSoft/lazarus/formats/mpq
``` ```
Go will fetch the code, but Cgo will fail to link the StormLib wrapper; Go will fetch the code, but Cgo will fail to link the StormLib wrapper;
we need to configure and build it: we need to configure and build it:
``` ```
$ cd $GOPATH/src/github.com/FooSoft/lazarus/formats/mpq/stormlib cd $GOPATH/src/github.com/FooSoft/lazarus/formats/mpq/stormlib
$ cmake . cmake .
$ make make
``` ```
You should now have a `libstorm.a` statically linked library in the `stormlib` directory. You should now have a `libstorm.a` statically linked library in the `stormlib` directory.
@ -57,31 +57,31 @@ Lazarus is only tested on Windows 10, but should in theory run on anything newer
2. Download and the latest 64-bit EXE installer for MSYS2 from the [official homepage](https://www.msys2.org/); install to the default directory. 2. Download and the latest 64-bit EXE installer for MSYS2 from the [official homepage](https://www.msys2.org/); install to the default directory.
3. Install the required packages (using the MSYS MinGW terminal): 3. Install the required packages (using the MSYS MinGW terminal):
``` ```
$ pacman -S mingw-w64-x86_64-gcc cmake make git mingw-w64-x86_64-SDL2 zlib-devel libbz2-devel pacman -S mingw-w64-x86_64-gcc cmake make git mingw-w64-x86_64-SDL2 zlib-devel libbz2-devel
``` ```
4. Add `C:\msys64\usr\bin` and `C:\msys64\mingw64\bin` to your system's `PATH` environment variable. 4. Add `C:\msys64\usr\bin` and `C:\msys64\mingw64\bin` to your system's `PATH` environment variable.
5. Build the [Dear ImGui](https://github.com/ocornut/imgui) wrapper package (using the system command prompt): 5. Build the [Dear ImGui](https://github.com/ocornut/imgui) wrapper package (using the system command prompt):
``` ```
$ go get github.com/FooSoft/lazarus/platform/imgui go get github.com/FooSoft/lazarus/platform/imgui
``` ```
Go will fetch the code, but Cgo will fail to link the [cimgui](https://github.com/cimgui/cimgui) wrapper; Go will fetch the code, but Cgo will fail to link the [cimgui](https://github.com/cimgui/cimgui) wrapper;
we need to configure and build it: we need to configure and build it:
``` ```
$ cd %GOPATH%/src/github.com/FooSoft/lazarus/platform/imgui/cimgui cd %GOPATH%/src/github.com/FooSoft/lazarus/platform/imgui/cimgui
$ cmake -DIMGUI_STATIC="yes" . cmake -DIMGUI_STATIC="yes" .
$ make make
``` ```
You should now have a `cimgui.a` statically linked library in the `cimgui` directory. You should now have a `cimgui.a` statically linked library in the `cimgui` directory.
6. Build the [StormLib](http://zezula.net/en/mpq/stormlib.html) wrapper package (using the system command prompt): 6. Build the [StormLib](http://zezula.net/en/mpq/stormlib.html) wrapper package (using the system command prompt):
``` ```
$ go get github.com/FooSoft/lazarus/formats/mpq go get github.com/FooSoft/lazarus/formats/mpq
``` ```
Go will fetch the code, but Cgo will fail to link the StormLib wrapper; Go will fetch the code, but Cgo will fail to link the StormLib wrapper;
we need to configure and build it: we need to configure and build it:
``` ```
$ cd %GOPATH%/src/github.com/FooSoft/lazarus/formats/mpq/stormlib cd %GOPATH%/src/github.com/FooSoft/lazarus/formats/mpq/stormlib
$ cmake . cmake .
$ make make
``` ```
You should now have a `libstorm.a` statically linked library in the `stormlib` directory. You should now have a `libstorm.a` statically linked library in the `stormlib` directory.
@ -97,7 +97,7 @@ Converts the frames of one or more DC6 animations to PNG files, using the provid
* Installation: * Installation:
``` ```
$ go get github.com/FooSoft/lazarus/tools/dc6 go get github.com/FooSoft/lazarus/tools/dc6
``` ```
* Usage: * Usage:
``` ```
@ -114,7 +114,7 @@ Extracts the contents of one or more MPQ archives to a target directory, using a
* Installation: * Installation:
``` ```
$ go get github.com/FooSoft/lazarus/tools/mpq go get github.com/FooSoft/lazarus/tools/mpq
``` ```
* Usage: * Usage:
``` ```
@ -134,7 +134,7 @@ palette is provided on the command line.
* Installation: * Installation:
``` ```
$ go get github.com/FooSoft/lazarus/tools/viewer go get github.com/FooSoft/lazarus/tools/viewer
``` ```
* Usage: * Usage:
``` ```