Add readme.md

This commit is contained in:
Zeex 2015-03-28 12:03:44 +05:00
parent 4843a44889
commit 8e53408cdb

40
readme.md Normal file
View File

@ -0,0 +1,40 @@
Pawn
====
[![Build Status][build_status]][build]
[![Build Status - Windows][build_status_win]][build_win]
[Original readme](readme.txt)
What is this?
-------------
This is a modified copy of the Pawn compiler version 3.2.3664 by Compuphase that
fixes some bugs and adds a few new features.
Changes
-------
See [Known compiler bugs](../../wiki/Known-compiler-bugs) for the list of fixed bugs
and [What's new](../../wiki/What's-new) for the list of other notable changes.
Background
----------
The project was originally started as a set of patches aimed to create a compiler
that would be compatible with the compiler used in [SA-MP (San Andreas Multiplayer)]
(http://sa-mp.com/).
SA-MP uses a modified version of Pawn 3.2.3664 [1] with Windows-only executables,
and the developers said that they lost the source code for it which means it can't
be ported to other platforms (e.g. Linux) and newly discovered bugs can't be fixed.
So the main goal of the project is to re-create changes that were
previously made by the devs as well as fix all known compiler bugs.
[1] It's worth noting that the version of the AMX embedded into the SA-MP server
seems to be based on a newer release of the Pawn toolkit.
[build]: https://travis-ci.org/Zeex/pawn
[build_status]: https://travis-ci.org/Zeex/pawn.svg?branch=master
[build_win]: https://ci.appveyor.com/project/Zeex/pawn/branch/master
[build_status_win]: https://ci.appveyor.com/api/projects/status/s1gb9p8dsy7hy1nw?svg=true