Simple AStar

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• GNU C Compiler
• GNU Makefile
• C++ Programming language
• C++ LibBoost
• Linux Containers
• Podman

Getting Started

Prerequisites

It is recommended to use Linux and have the following installed:

• GNU C++ compiler
• GNU make
• C++ Boostlib
• Git
• Podman or equivalent software (Docker)

Installation

1. Clone the repo

git clone https://github.com/HackTestes/SimpleAStar.git ./SimpleAStar

2. Change to the SimpleAStar directoty

cd SimpleAStar

3. Compile the code using the makefile

make

4. Clean unecessary files from the compilation process

make clean

Usage

To run the executable, just type the following command:

./SimpleAStarExecutable --help

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Caio Gomes Flausino - [email protected] - [email protected]

Project Link: https://github.com/HackTestes/SimpleAStar

Acknowledgements

• Best-README-Template
• Daniel
• Diego