Skip to content

Commit

Permalink
Rename README to README.md
Browse files Browse the repository at this point in the history
Add option to tell automake to not require README.
  • Loading branch information
zturtleman committed Apr 21, 2023
1 parent fd1165f commit dcab85e
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 74 deletions.
145 changes: 72 additions & 73 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,72 @@
This is the README file for Maverick Model 3D

Maverick Model 3D is a 3D model editor. It was written and tested on Linux.
It is reported to run on other Unix-like operating systems. It also runs
on Windows. See INSTALL.WIN32 for Windows-specific instructions.

It is based on Misfit Model 3D that was developed by Kevin Worcester from 2004
to 2009. Maverick Model 3D is maintained by Zack Middleton (zturtleman).

The home page is here:
https://clover.moe/mm3d

The original project's home page is here:
http://www.misfitcode.com/misfitmodel3d/

Maverick Model 3D requires Qt (5.x) and OpenGL support. See the INSTALL file
for details on where to get these packages.

This program uses autoconf and automake for building from source. What this
means is that if you are lucky you can install this program with these
easy steps:

./autogen.sh
./configure
make
sudo make install

This will build a 'mm3d' executable and install it in /usr/local/bin.
Documentation will be in /usr/local/share/doc/mm3d.

For more detailed installation instructions, see the INSTALL file.
See INSTALL.WIN32 for Windows-specific instructions.

## Debian/Ubuntu

Build dependencies:

sudo apt install autoconf automake make gcc g++ qtbase5-dev qtbase5-dev-tools qttools5-dev-tools libgl1-mesa-dev

qttranslations5-l10n can be used at run-time.

## Fedora

Build dependencies:

sudo dnf install autoconf automake make gcc gcc-c++ qt5-qtbase-devel qt5-linguist mesa-libGLU-devel

qt5-qttranslations can be used at run-time.

## Arch Linux

Build dependencies:

sudo pacman -S autoconf automake make gcc qt5-base qt5-tools glu

qt5-translations can be used at run-time.

## macOS

To build a "Maverick Model 3D.app" AppBundle on macOS 10.14+,
install homebrew from http://brew.sh and run the following commands.

(I haven't tested these build steps as my MacBook Pro is limited to
macOS 10.11 and Qt 5.12+ no longer supports it.)

brew install autoconf automake qt@5
./autogen.sh
./configure --with-Qt-dir=/usr/local/Cellar/qt/5.15.2 --with-macosx-version-min=10.13
make
make appbundle

--with-macosx-version-min should be set to the value in
/usr/local/Cellar/qt/5.15.2/mkspecs/macx-clang/qmake.conf
Maverick Model 3D
-----------------

Maverick Model 3D is a 3D model editor. It was written and tested on Linux.
It is reported to run on other Unix-like operating systems. It also runs
on Windows.

It is based on [Misfit Model 3D](http://www.misfitcode.com/misfitmodel3d/)
that was developed by Kevin Worcester from 2004 to 2009. Maverick Model 3D
is maintained by Zack Middleton (zturtleman).

The home page is here:
https://clover.moe/mm3d

Maverick Model 3D requires Qt (5.x) and OpenGL support. See the INSTALL file
for details on where to get these packages.

This program uses autoconf and automake for building from source. What this
means is that if you are lucky you can install this program with these
easy steps:

./autogen.sh
./configure
make
sudo make install

This will build a 'mm3d' executable and install it in /usr/local/bin.
Documentation will be in /usr/local/share/doc/mm3d.

For more detailed installation instructions, see the INSTALL file.
See INSTALL.WIN32 for Windows-specific instructions.

## Debian/Ubuntu

Build dependencies:

sudo apt install autoconf automake make gcc g++ qtbase5-dev qtbase5-dev-tools qttools5-dev-tools libgl1-mesa-dev

qttranslations5-l10n can be used at run-time.

## Fedora

Build dependencies:

sudo dnf install autoconf automake make gcc gcc-c++ qt5-qtbase-devel qt5-linguist mesa-libGLU-devel

qt5-qttranslations can be used at run-time.

## Arch Linux

Build dependencies:

sudo pacman -S autoconf automake make gcc qt5-base qt5-tools glu

qt5-translations can be used at run-time.

## macOS

To build a "Maverick Model 3D.app" AppBundle on macOS 10.14+,
install homebrew from http://brew.sh and run the following commands.

(I haven't tested these build steps as my MacBook Pro is limited to
macOS 10.11 and Qt 5.12+ no longer supports it.)

brew install autoconf automake qt@5
./autogen.sh
./configure --with-Qt-dir=/usr/local/Cellar/qt/5.15.2 --with-macosx-version-min=10.13
make
make appbundle

--with-macosx-version-min should be set to the value in
/usr/local/Cellar/qt/5.15.2/mkspecs/macx-clang/qmake.conf
2 changes: 1 addition & 1 deletion configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dnl Makefile.am (for Contents/PlugIns/mm3d/x.x)
dnl plugins/Makefile.am (for plugins/x.x)

AC_INIT([mm3d], [1.3.13])
AM_INIT_AUTOMAKE
AM_INIT_AUTOMAKE([foreign])
AC_CONFIG_SRCDIR([config.h.in])
AC_CONFIG_HEADERS([config.h])

Expand Down

0 comments on commit dcab85e

Please sign in to comment.