Skip to content

Commit

Permalink
improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
anaseto committed Feb 19, 2021
1 parent 940b77d commit b8014cc
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
Expand Up @@ -20,12 +20,13 @@ Architecture](https://guide.elm-lang.org/architecture/). The architecture has
been adapted to be more idiomatic in Go in the context of grid-based
applications: less functional and more efficient.

You can find there [annotated
examples](https://github.com/anaseto/gruid-examples/) and the
[documentation](https://pkg.go.dev/github.com/anaseto/gruid).
You can find examples below in the [Examples section](#examples).

# Overview of packages

The full documentation is linked at the top of this README. We provide here a
quick overview.

The **gruid** package defines the Model and Driver interfaces and allows to
start the “update on message then draw” main loop of an application. It also
defines a convenient and efficient slice grid structure to represent the
Expand All @@ -43,9 +44,10 @@ The **paths** package provides efficient implementations of some common
pathfinding algorithms that are often used in grid-based games, such as
roguelikes. You will find implementations of the A\* and
[JPS](https://en.wikipedia.org/wiki/Jump_point_search) algorithms, as well as
Dijkstra, breadth first, and connected components maps computations. See the
[movement example](https://github.com/anaseto/gruid-examples/movement/move.go)
for an annotated example using JPS and the mouse.
Dijkstra, breadth first, and connected components maps computations. See
`move.go` in the movement example in
[gruid-examples](https://github.com/anaseto/gruid-examples) for an annotated
example using JPS and the mouse.

The **rl** package provides some additional utilities commonly needed in
grid-based games such as roguelikes. The package provides an event priority
Expand All @@ -66,9 +68,10 @@ a bit of HTML and js).

# Examples

In addition of the simple [annotated
examples](https://github.com/anaseto/gruid-examples/) previously mentioned, you
may want to look also into some real world examples of gruid programs:
The [gruid-examples](https://github.com/anaseto/gruid-examples) module offers
some simple annotated examples of gruid usage.

You may want to look also into some real world examples of gruid programs:

+ [harmonist](https://github.com/anaseto/harmonist) : a stealth roguelike game.
+ [gospeedr](https://github.com/anaseto/gospeedr) : a simple speed reading program.
Expand Down

0 comments on commit b8014cc

Please sign in to comment.