Skip to content

Commit

Permalink
Add README and screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
tatokis committed May 21, 2020
1 parent 5cda01b commit 306724d
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# BetterTRN
An educational computer emulator!
___

![screenshot](https://raw.githubusercontent.com/tatokis/bettertrn/master/screenshot.png)

Originally developed at NTUA.

Unfortunately, the original software was really slow, with many bugs, and practically unusable on Linux despite being written in Java.
BetterTRN is a complete implementation of the TRN+ computer from scratch, using the cross platform Qt framework, with many, many improvements.

## Installation

### Windows
Download the latest [win32 release archive](https://github.com/tatokis/bettertrn/releases/latest) and extract it somewhere. Then run `bettertrn.exe`.

### Linux
Build from source. Either use Qt Creator, or run the following commands.
Instructions are for Ubuntu, but should apply to all distros with the appropriate package manager command

```
sudo apt install build-essential git qt5-default
git clone https://github.com/tatokis/bettertrn
cd bettertrn
qmake && make -j4
./bettertrn
```

### macOS
Either install the official Qt package and open up the project in Qt Creator, or use homebrew with qmake + make

## Documentation and examples
Can be found inside the docs and examples folders.

## License
Licensed under GNU GPLv3 or (at your option) any later version. See LICENSE.
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 306724d

Please sign in to comment.