Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #47

Open
wants to merge 1 commit into
base: development
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
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,6 @@
<img src="https://github.com/Guitarheroua/protomorph-bg/blob/development/old-src/ProtomorphBG/resources/icons/protomorph-bg.ico" />
</p>

To compile a program, you need connect Flatbuffer library.
You can do this by editing flatbuffers.pri file or add arguments to qmake

<pre><code>FLATBUFFERS_INCLUDE_DIR - directory where flatbuffers include files are located
FLATBUFFERS_LIB_DIR - directory where flatbuffers libs are located
FLATC_SCHEME_FILES - list of flatbuffers schema files used to generate headers
</pre></code>

Example:
<pre><code>FLATBUFFERS_INCLUDE_DIR=D:/MSYS2_Commander/msys64/mingw64/include
FLATBUFFERS_LIB_DIR=D:/MSYS2_Commander/msys64/mingw64/lib</pre></code>

**"Protomorph BG"** is a tool, that will help board game designers to prototype games components(cards, tiles, boards etc.) and save them as a project. It will also have layouts mechanisms, to layout components for printing on standard paper formats and export entire project to PDF or other formats. Will be available for Windows/Linux/OSX (I hope :))

## Status
Expand All @@ -39,6 +27,20 @@ Next sources are used in the project:

3. [**mitchcurtis/slate**](https://github.com/mitchcurtis/slate) - Pixel Art Editor(Collapsible panels and color scheme used from this project)

## FlatBuffers

To compile a program, you need connect Flatbuffer library.
You can do this by editing flatbuffers.pri file or add arguments to qmake

<pre><code>FLATBUFFERS_INCLUDE_DIR - directory where flatbuffers include files are located
FLATBUFFERS_LIB_DIR - directory where flatbuffers libs are located
FLATC_SCHEME_FILES - list of flatbuffers schema files used to generate headers
</pre></code>

Example:
<pre><code>FLATBUFFERS_INCLUDE_DIR=D:/MSYS2_Commander/msys64/mingw64/include
FLATBUFFERS_LIB_DIR=D:/MSYS2_Commander/msys64/mingw64/lib</pre></code>

## Our support

UI/UX Designer - **Anthony Hobday**
Expand Down