Commit 9f082510 authored by Edgar Yépez's avatar Edgar Yépez 💬
Browse files

Update README

parent d0c0b853
......@@ -2,7 +2,7 @@
## Description
TreeProblemFramework is a .NET Core library to solve problems/games whose solution is based on a tree search. Its input should consist of a definition for the problem/game, including the corresponding rules, a description of the solution and an initial state. Moreover and optionally, an heuristic might also be given as part of the input. After processing, the library outputs the steps that reach the solution while satisfying the rules.
TreeProblemFramework is a .NET Core library to solve puzzles whose solution is based on a tree search. Its input should consist of a definition for the puzzle, including the corresponding rules, a description of the solution and an initial state. Moreover and optionally, an heuristic might also be given as part of the input. After processing, the library outputs the steps that reach the solution while satisfying the rules.
### Use case
......@@ -18,7 +18,7 @@ The library might be used to solve problems/games such as:
## License
Usage of the library is governed by the [MIT License](https://opensource.org/licenses/MIT), therefore, in case of any full or partial usage, do clearly link to the repository [https://gitlab.com/EdgarYepez/TreeProblemFramework](https://gitlab.com/EdgarYepez/TreeProblemFramework) as following:
Although usage of the library is governed by the [MIT License](https://opensource.org/licenses/MIT), do clearly link to the repository [https://gitlab.com/EdgarYepez/TreeProblemFramework](https://gitlab.com/EdgarYepez/TreeProblemFramework) as follows in case of any full or partial usage:
```
@software {yepezTPF,
......@@ -29,14 +29,14 @@ Usage of the library is governed by the [MIT License](https://opensource.org/lic
}
```
In case of having any comments, suggestions or finding issues, send an e-mail to [tpf@esyl.io](mailto:tpf@esyl.io).
In case of having any comments, suggestions or finding issues, send an e-mail to [dev@esyl.io](mailto:dev@esyl.io).
Copyright 2020 ESYL.
## Installation
Instructions on how to reference the library shall be found on the [ESYL.TreeProblemFramework nuget site](https://www.nuget.org/packages/ESYL.TreeProblemFramework/).
Instructions on how to reference the library shall be found in the [ESYL.TreeProblemFramework nuget site](https://www.nuget.org/packages/ESYL.TreeProblemFramework/).
## Usage
For instructions on how to get started, visit the [usage guide](https://gitlab.com/EdgarYepez/TreeProblemFramework/-/wikis/home). Additionally, implementations for a solution to several problems/games shall be found in the [Examples folder](https://gitlab.com/EdgarYepez/TreeProblemFramework/tree/master/Examples).
\ No newline at end of file
For instructions on how to get started, visit the [usage guide](http://tpf.esyl.io/api/index.html). Additionally, implementations for a solution to several puzzles shall be found in the [Examples folder](https://gitlab.com/EdgarYepez/TreeProblemFramework/tree/master/Examples).
\ No newline at end of file
......@@ -39,4 +39,4 @@ Instructions on how to reference the library shall be found in the [ESYL.TreePro
## Usage
For instructions on how to get started, visit the [usage guide](https://gitlab.com/EdgarYepez/TreeProblemFramework/-/wikis/home). Additionally, implementations for a solution to several puzzles shall be found in the [Examples folder](https://gitlab.com/EdgarYepez/TreeProblemFramework/tree/master/Examples).
\ No newline at end of file
For instructions on how to get started, visit the [usage guide](/api/index.html). Additionally, implementations for a solution to several puzzles shall be found in the [Examples folder](https://gitlab.com/EdgarYepez/TreeProblemFramework/tree/master/Examples).
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment