Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
freq-mod authored and Wohlstand committed Dec 16, 2020
1 parent e334d5b commit 7a58982
Showing 1 changed file with 63 additions and 5 deletions.
68 changes: 63 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OPN2BankEditor
![OPN2 Editor Logo](src/resources/opn2_48.png)

A small cross-platform editor of the OPN2 FM chip (which is widely used in Sega Genesis (aka Mega Drive) game console)
A small cross-platform editor for the OPN family of FM synthesis soundchips (which were widely used in Sega Genesis (aka Mega Drive) game console), Fujitsu FM Towns home computer and NEC PC-88 and PC-98 home computer series.)

# CI Build status
Linux | Windows (32-bit) | macOS
Expand All @@ -20,18 +20,76 @@ Linux | Windows (32-bit) | macOS
* CIs for other operating systems are coming soon... (However, it's easy to build it by yourself :wink:)

# How to build
You need a Qt 5 to build this project.
**Prerequisites**
This editor requires following dependences on Linux-based systems.
Debian and it's derivatives:
```
build-essentials
libasound2-dev
zlib1g-dev
cmake
qt5-default
qttools5-dev
libpulse-dev
libqwt-qt5-dev //OPTIONAL
libjack-dev //OPTIONAL
```
Arch and it's derivatives:
```
desktop-file-utils
hicolor-icon-theme
jack
libpulse
qwt
cmake
qt5-base
qt5-tools
```
Before you start the build, make sure you have also cloned submodules!

Run next commands from project directory:
```
qmake CONFIG+=release CONFIG-=debug FMBankEdit.pro
make -j 4
git submodule init
git submodule update
```
**Building with CMake**

Navigate to the project directory in a terminal and follow this build procedure.

```
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..
make
sudo make install
```

This will result in a software installation located in /usr/local, with program shortcuts, icons and MIME type associations.

**Building with QMake**

The easiest way is to open FMBankEdit.pro in the QtCreator software and run a compilation. Alternatively, you can also build manually on the command line.

Navigate to the project directory in a terminal and follow this build procedure.

```
qmake CONFIG+=release CONFIG-=debug FMBankEdit.pro
make
```
As alternate way you can open FMBankEdit.pro in the Qt Creator and build it.

## Languages

As of version 1.3.1, this tool supports following languages:

* English
* Français (French)
* Русский (Russian)
* Polski (Polish)

# Folders
* ***Bank_Examples*** - example bank files which you can edit and preview them
* ***Specifications*** - documentation of file formats used by this tool
* ***cmake*** - CMake-related scripts
* ***src*** - source code of this tool
* ***_Misc*** - Various stuff (test scripts, dummy banks, documents, etc.) which was been used in development of this tool

0 comments on commit 7a58982

Please sign in to comment.