lib/serialization: add README.md
[nit.git] / lib / ai / backtrack.nit
index f8c17c5..550df10 100644 (file)
@@ -13,6 +13,8 @@
 # This module provides a simple abstract class `BacktrackProblem[S,A]` to be specialized for a specific problem.
 #
 # The concrete class `BacktrackSolver` is used to configure, query, and run a solver for a given problem.
+#
+# For an example, see the `queens.nit` program in the `examples` subdirectory.
 module backtrack
 
 # Abstract backtrack problem of states (`S`) and actions (`A`).
@@ -84,7 +86,7 @@ end
 # 2. Apply the method `run`, that will search and return a solution.
 # 3. Retrieve information from the solution.
 #
-# ~~~~
+# ~~~~nitish
 # var p: BacktrackProblem = new MyProblem
 # var solver = p.solve
 # var res = solver.run