Skip to content

Commit

Permalink
README.md updated: better wording, API remarks, spelling and Ada chat…
Browse files Browse the repository at this point in the history
… badge.
  • Loading branch information
mgrojo committed Nov 11, 2021
1 parent 45f1e9f commit c181f28
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[![SFML logo](https://www.sfml-dev.org/images/logo.png)](https://www.sfml-dev.org)
![Ada (GNAT)](https://github.com/mgrojo/ASFML/workflows/Ada%20(GNAT)/badge.svg)
[![Alire](https://img.shields.io/endpoint?url=https://alire.ada.dev/badges/asfml.json)](https://alire.ada.dev/crates/asfml.html)
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/ada-lang/Lobby)

# ASFML — Ada's Simple and Fast Multimedia Library

Expand All @@ -17,39 +18,41 @@ It is writen in standard Ada without the use of any specific GNAT extensions, bu
## State

The binding is considered complete. Three versions of [CSFML](https://github.com/SFML/CSFML)
have been bound: 1.6, 2.4 and 2.5 (see releases). The API might not be 100% stable though, some changes could be made in the future to improve usability.
have been bound: 1.6, 2.4 and 2.5 (see releases). The API is considered stable, changes would only be made to fix errors or to upgrade to a new SFML version.

## Documentation

Generated documentation can be consulted [online](https://mgrojo.github.io/ASFML/doc/).
Generated API documentation can be consulted [online](https://mgrojo.github.io/ASFML/doc/).

## How to build
## How to build with Alire

This library is available in [Alire](https://alire.ada.dev/) so building is as easy as installing Alire and then executing:
`alr build asfml`

## How to build without Alire

Install CSFML following instructions of your platform. For example, under Ubuntu or Debian:
`sudo apt-get install gnat gprbuild libcsfml-dev libglu1-mesa-dev`

Open a terminal and run this command:
`gprbuild asfml.gpr`

This version is available in [Alire](https://alire.ada.dev/) so installation can be as easy as executing:
`alr build asfml`

## How to use

To compile your program you need to "with" the `asfml.gpr` projects. Then
To compile your program you need to "with" the `asfml.gpr` project. Then
you can build using gprbuild.

Use `asfml_opengl.gpr` if you are using OpenGL.

Under Windows, you might need to update the path to your libraries in the
provided GPR files.

Using alire you can add this library to you project as simply as:
Using alire you can add this library to your project as simply as:
`alr with asfml`

## Examples
You can see simple test examples in the `tests` directory. For some demo games,
you can review the project [16-Games](https://github.com/mgrojo/16-Games).

Links to projects using ASFML CAN be found in the
Links to projects using ASFML can be found in the
[Wiki](https://github.com/mgrojo/ASFML/wiki#list-of-projects-using-asfml).

0 comments on commit c181f28

Please sign in to comment.