Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
raldus committed Apr 21, 2017
1 parent c0f9688 commit dd69a3d
Showing 1 changed file with 24 additions and 22 deletions.
46 changes: 24 additions & 22 deletions README.md
Expand Up @@ -4,18 +4,19 @@
Roland is an emulator of the homecomputers Amstrad/Schneider from the series CPC 464/664/6128
for Linux und Windows.
Roland depends on SDL > 1.2 and SDL-Image.
For further information visit https://www.rolandemu.de/
For further information visit https://www.rolandemu.de/.
You can find the latest API Documentation on https://www.rolandemu.de/en/information/api.html

## Build
The source is written in c++11 code and needs at leat a c++11 enabled Compiler. Supported are GCC native, Visual Studio 2015 or CygWin/MinGw.

### Status
OS|Detail|Status
---|---|--:
Ubuntu|32 & 64 bit|[![Build Status](https://travis-ci.org/raldus/roland.svg?branch=master)](https://travis-ci.org/raldus/roland)
Windows|32 & 64 bit|[![Build status](https://ci.appveyor.com/api/projects/status/ced6joh6ichpeqaf/branch/master?svg=true)](https://ci.appveyor.com/project/raldus/roland-0xe5q/branch/master)
-|CodeClimate|[![Code Climate](https://codeclimate.com/github/raldus/roland/badges/gpa.svg)](https://codeclimate.com/github/raldus/roland)|
-|Codacy|[![Codacy Badge](https://api.codacy.com/project/badge/Grade/19a42389d36f4f99b2827aff199d2f8c)](https://www.codacy.com/app/raldus/roland?utm_source=github.com&utm_medium=referral&utm_content=raldus/roland&utm_campaign=Badge_Grade)|
Plattform|Status
---|--:
Ubuntu 64 bit|[![Build Status](https://travis-ci.org/raldus/roland.svg?branch=master)](https://travis-ci.org/raldus/roland)
Windows 32 & 64 bit VS2013|[![Build status](https://ci.appveyor.com/api/projects/status/ced6joh6ichpeqaf/branch/master?svg=true)](https://ci.appveyor.com/project/raldus/roland-0xe5q/branch/master)
CodeClimate|[![Code Climate](https://codeclimate.com/github/raldus/roland/badges/gpa.svg)](https://codeclimate.com/github/raldus/roland)|
Codacy|[![Codacy Badge](https://api.codacy.com/project/badge/Grade/19a42389d36f4f99b2827aff199d2f8c)](https://www.codacy.com/app/raldus/roland?utm_source=github.com&utm_medium=referral&utm_content=raldus/roland&utm_campaign=Badge_Grade)|

### General
You will need cmake and git installed.
Expand Down Expand Up @@ -74,27 +75,27 @@ F10|exit
F12|toggle fullscreen

### Usage of the CPC 464/664/6128
Insert a disk, enter **cat** **Enter** and
you will see the directory. Enter **run "filename"** **Enter** (mostly *.bas).
Insert a disk, enter 'cat' [Enter] and
you will see the directory. Enter 'run "filename"' [Enter] (mostly *.bas).

#### Example
>
1. press **F2**
2. search a disk with **arrowkeys** (HarveyH.dsk) **Enter**
3. type **cat** **Enter**
4. in this case the file is named **Harvey**
5. type **run "harvey"** **Enter**
6. press **F5** to emulate a joystick with **arrowkeys** and **ALT**
1. press [F2]
2. search a disk with [arrowkeys] (HarveyH.dsk) [Enter]
3. type 'cat' [Enter]
4. in this case the file is named 'Harvey'
5. type 'run "harvey"' [Enter]
6. press [F5] to emulate a joystick with [arrowkeys] and [ALT]

#### Example 2 (Bjack1.dsk)
>
1. ...
2. ...
3. ...
4. in this case the file is named **Bomb.bin**
5. enter **run "bomb** **Enter**
4. in this case the file is named 'Bomb.bin'
5. enter 'run "bomb' [Enter]

In most cases, there is a *.bas file on the disk
In most cases, there is a '*.bas' file on the disk
to start the appropriate software. e.g.: disc.bas

## Configuration
Expand All @@ -112,15 +113,16 @@ working settings:

### Linux
Before you can start the Linux version, you have to adjust some pathes in
**roland-linux.cfg**.
'roland-linux.cfg'.
```text
cpcrom=/mnt/shared/emu/cpc/roms/cpc6128.rom -> /../ThisFolder/roms/cpc6128.rom
amsdos=/mnt/shared/emu/cpc/roms/amsdos.rom -> /../ThisFolder/roms/amsdos.rom
diskdir=/mnt/shared/emu/cpc/dsk -> /../ThisFolder/disks
```
Afterwards, put **roland-linux.cfg** renamed to **.roland** into your homedir.
Afterwards, put 'roland-linux.cfg' renamed to '.roland' into your homedir.

## Misc
[Changelog](https://github.com/raldus/roland/blob/master/CHANGELOG.md)
<br><br><br>
[ ![Ready](https://github.com/raldus/roland/blob/master/assets/img/ready.png)](https://www.rolandemu.de/index.html)

## Documentation
You can find the latest API Documentation on https://www.rolandemu.de/en/information/api.html

0 comments on commit dd69a3d

Please sign in to comment.