Skip to content

Commit

Permalink
Add some installation instructions for Ubuntu
Browse files Browse the repository at this point in the history
  • Loading branch information
mackorone committed Jan 28, 2019
1 parent ab8e844 commit 04707ea
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 15 deletions.
53 changes: 39 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,28 +39,53 @@ Previous versions of *mms* exist in the `old/` directory.

## Installation

#### Pre-compiled Binaries
In the near future, we'll provide pre-compiled binaries. Until then, you need
to build from source. At a high level, the steps are as follows:

In the near future, we'll provide pre-compiled binaries on these three platforms:
1. Install Qt and other dependencies
1. Build `mms/src/sim/sim.pro`
1. Run `mms/bin/sim`

* Windows
* Mac OS X
* Linux
#### Windows

Until then, you'll have to build from source.
TODO

#### Build From Source
#### Mac OS

1. Download Qt (see [this download page](https://www.qt.io/download/))
1. Use the `sim.pro` file in `src/sim` to configure and build the project
1. Run the resultant binary
TODO

For example, on Ubuntu, run the following:
#### Linux (Ubuntu)

Qt installation option #1: use the command line
```
sudo apt-get install qt5-default
```

Qt installation option #2: use the installer

1. Download the Qt open source installer: https://www.qt.io/download/
1. Make the installer executable: `chmod +x qt-unified-linux-x64-3.0.6-online.run`
1. Run the installer executable: `./qt-unified-linux-x64-3.0.6-online.run`
1. If you don't already have a Qt account, you'll need to make one
1. When prompted to select components, [choose "Desktop gcc 64-bit"](https://github.com/mackorone/mms/blob/master/img/qt-install-ubuntu.png)
1. Once the installer finishes, the `qmake` binary can be found in the installation directory

More documentation:

* https://wiki.qt.io/Install_Qt_5_on_Ubuntu
* http://doc.qt.io/qt-5/linux.html

Clone, build, and run the project:

```bash
cd src/sim
qmake
make
# Clone the repo
git clone [email protected]:mackorone/mms.git

# Build the simulator
cd mms/src/sim
qmake && make

# Run the simulator
../../bin/sim
```

Expand Down
Binary file added img/qt-install-ubuntu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/sim/Window.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ Window::Window(QWidget *parent) :
configLayout->addWidget(m_mazeFileComboBox, 0, 1, 1, 2);
connect(
m_mazeFileComboBox,
QOverload<const QString &>::of(&QComboBox::activated),
static_cast<void(QComboBox::*)(const QString&)>(&QComboBox::activated),
this,
&Window::onMazeFileComboBoxChanged
);
Expand Down
1 change: 1 addition & 0 deletions src/sim/sim.pro
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ QT += widgets

TEMPLATE = app

CONFIG += c++11
CONFIG += debug
CONFIG += object_parallel_to_source
CONFIG += qt
Expand Down

0 comments on commit 04707ea

Please sign in to comment.