Skip to content

Commit

Permalink
Updated Readme with new description and Logos
Browse files Browse the repository at this point in the history
  • Loading branch information
lronaldo committed May 10, 2015
1 parent 4c26d68 commit c553040
Showing 1 changed file with 32 additions and 16 deletions.
48 changes: 32 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,52 @@
![CPCtelera Logo](http://lronaldo.github.io/cpctelera/images/cpct_logo.png)
![CPCtelera Logo][CPCTLogo]

_**Astonishing fast Amstrad CPC game engine for C developers**_
_**Astonishing fast Amstrad CPC game engine for C and Assembler developers**_

---------------------------------------------------------------

_**CPCtelera**_ is a game engine for Amstrad CPC computers whose aim is to have the fastest possible
routines to aid developers in the creation of games. The main aims of _**CPCtelera**_ are producing the fastest possible code, being very easy to install and use in every modern platform and having an extensively commented code, to aid those wanting to learn from code.

**Installing and using** _**CPCtelera**_ is very easy:
* [How to install CPCtelera](http://lronaldo.github.io/cpctelera/files/readme-txt.html#Installing_CPCtelera)
* [CPCtelera reference manual](http://lronaldo.github.io/cpctelera/files/readme-txt.html)
_**CPCtelera**_ is an integrated development framework for creating _**Amstrad CPC**_ games and content which includes:
* A low-level library with support for: graphics, audio, keyboard, firmware, strings, video hardware manipulation and memory management.
* An API for developing games and software in *C* and Assembler.
* A complete multi-platform building system with support for building CDTs and DSKs automatically.
* Tools for content authoring (audio, graphics and level editing)

_**CPCtelera**_ has been conceived with these aims in mind:
* Delivering a convenient, usable and fast environment for developing games
* Providing an up-to-date, detailed and easy to consult documentation
* Giving technical details of the complete implementation for those curious
* Easing the install and configuration process

**Starting with** _**CPCtelera**_ is very easy:
* [**How to install CPCtelera**](http://lronaldo.github.io/cpctelera/files/readme-txt.html#Installing_CPCtelera)
* [**CPCtelera reference manual**](http://lronaldo.github.io/cpctelera/files/readme-txt.html)

If you are a Mac user, you will want to consider installing [CPCtelera-samples-Xcode](https://github.com/dfreniche/cpctelera_samples_xcode) by [Diego Freniche](http://blog.freniche.com), along with _**CPCtelera**_. This package creates Xcode projects from examples and lets you build them directly from Xcode.

### Supported Platforms

* Windows (with Cygwin 32/64 bits)
* Windows (with [Cygwin][Cygwin] 32/64 bits)
* OS X
* Linux (Ubuntu/Debian, Raspbian, Arch and Manjaro)
* Linux

If you test it in any platform (listed here or not) and have problems, please feel free to report them to us.

### Contact information and support
If you are a Mac user, you will want to consider installing [CPCtelera-samples-Xcode](https://github.com/dfreniche/cpctelera_samples_xcode) by [Diego Freniche](http://blog.freniche.com), along with _**CPCtelera**_. This package creates Xcode projects from examples and lets you build them directly from Xcode.

If you have any questions, please contact us:
### Contact information and support

* email: [email protected]
* twitter: *[@FranGallegoBR](http://twitter.com/frangallegobr)*

### Authors and License

* (C) Copyright 2014-2015 [CPCtelera's authors](http://lronaldo.github.io/cpctelera/files/authors-txt.html)
* (C) Copyright 2014-2015 [CPCtelera's _awesome_ authors](http://lronaldo.github.io/cpctelera/files/authors-txt.html)
* Distributed under [GNU General Public License v3](http://lronaldo.github.io/cpctelera/files/license-txt.html)


[![Cheesetea Logo][CTLogo]](http://www.cheesetea.com) [![Fremos logo][FRLogo]](http://fremos.cheesetea.com)

[![ByteRealms Logo][BRLogo]](http://www.byterealms.com) [![Carlio Logo][CLLogo]](http://www.carlio.es)

[CTLogo]: http://lronaldo.github.io/cpctelera/images/logo_cheesetea_230.png
[FRLogo]: http://lronaldo.github.io/cpctelera/images/logo_fremos_230.png
[BRLogo]: http://lronaldo.github.io/cpctelera/images/logo_byterealms_230.png
[CLLogo]: http://lronaldo.github.io/cpctelera/images/logo_carlio_230.png
[CPCTLogo]: http://lronaldo.github.io/cpctelera/images/cpct_logo.png
[Cygwin]: http://www.cygwin.com

0 comments on commit c553040

Please sign in to comment.