Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Add initial Linux build instructions to readme? #31

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ To build this project, you must install `CMake (>=3.21)`, `Ninja` and `Visual St

Then, a build should start, and when it's done, your command prompt will be moved to the output directory, which should contain a `TeamSCALEFORM.dll` binary.

# Building - Linux
On Linux you will need to install `Ninja` & `CMake (>=3.21)`, then clone the repository and build it.
```bash
git clone https://github.com/TeamSCALEFORM/scaleform
cd scaleform
cmake -G Ninja
ninja
```
You should now have a `libTeamSCALEFORM.so` in your current directory.

# Ports
We support ports of the boilerplate to software's APIs. If you developed a port of the scaleform boilerplate, open a pull request that links your repository under this comment.
<!-- Here! Remember to use [name](url) -->
Expand Down