Skip to content

Commit

Permalink
Merge branch 'master' of github.com:BlaXpirit/nim-csfml
Browse files Browse the repository at this point in the history
  • Loading branch information
oprypin committed Jan 8, 2015
2 parents 254aecd + 7e1093d commit fb938fa
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Introduction
The API attempts to be very similar to SFML's, but some general changes are present:

- To construct an object (`sf::SomeType x(param)`), use a corresponding procedure (there are 2 variations):
- `var x = newSomeType(param)`, which means it is a `ref object`.
- `var x = newSomeType(param)`, which means it is a `ptr object`.
- Such objects have [destructors][nim-destructors] associated with them (no need to call `destroy` manually).
- Never create them using `new`.
- `var x = someType(param)`, which means it is an `object` (in CSFML it corresponds to a simple `struct`).
Expand All @@ -50,7 +50,7 @@ The API attempts to be very similar to SFML's, but some general changes are pres
- `unsigned int` is mapped as `cint`, etc., so you don't have to bother with unsigned conversions. This shouldn't cause problems, but it might.
- The *util* module contains some types that provide implicit conversions.
- For example `sfBool` which is defined as `int`, is mapped to the `IntBool` type with conversions to Nim's `bool`.
- If you want to use some particular CSFML function but don't know what it maps to in *nim-csml*, you can just search for its name in the [documentation][].
- If you want to use some particular CSFML function but don't know what it maps to in *nim-csfml*, you can just search for its name in the [documentation][].
- Most of the [documentation][] is taken directly from CSFML, so don't be surprised if it talks in C/C++ terms.

See [examples](examples) to learn more.
Expand Down

0 comments on commit fb938fa

Please sign in to comment.