From a0dbc1d647ef29d05b1e8ca7f051334065958305 Mon Sep 17 00:00:00 2001 From: erwan-joly Date: Tue, 21 Apr 2026 12:40:58 +1200 Subject: [PATCH] docs: refresh README, add CodeRabbit config - Remove AWS sponsor, keep Navicat only - Replace German Achtung with English Warning - Swap dead Discord CDN images for GitHub-hosted icons; drop dead discordapp.net GUI screenshot, link the algorithm docs instead - Fix workflow badge casing (NosCore.Pathfinder -> NosCore.PathFinder) - Add .coderabbit.yaml for open-source code review Co-Authored-By: Claude Opus 4.7 (1M context) --- .coderabbit.yaml | 20 ++++++++++++++++++++ README.md | 38 +++++++++++++++++++++++--------------- 2 files changed, 43 insertions(+), 15 deletions(-) create mode 100644 .coderabbit.yaml diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 0000000..843d058 --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,20 @@ +language: "en" +early_access: false +reviews: + profile: "chill" + request_changes_workflow: false + high_level_summary: true + poem: false + review_status: true + collapse_walkthrough: false + auto_review: + enabled: true + drafts: false + path_filters: + - "!**/*.min.js" + - "!**/bin/**" + - "!**/obj/**" + - "!**/TestResults/**" + - "!**/*.Designer.cs" +chat: + auto_reply: true diff --git a/README.md b/README.md index 1dc0d0f..f292d9f 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,48 @@ # NosCore.PathFinder #

- +

[![NuGet](https://img.shields.io/nuget/v/NosCore.PathFinder.svg?style=flat-square)](https://www.nuget.org/packages/NosCore.PathFinder/) -[![.NET](https://github.com/NosCoreIO/NosCore.Pathfinder/actions/workflows/dotnet.yml/badge.svg?branch=master)](https://github.com/NosCoreIO/NosCore.Pathfinder/actions/workflows/dotnet.yml) +[![.NET](https://github.com/NosCoreIO/NosCore.PathFinder/actions/workflows/dotnet.yml/badge.svg?branch=master)](https://github.com/NosCoreIO/NosCore.PathFinder/actions/workflows/dotnet.yml) # Special Thanks for Contributions #

- - - +

+## You want to contribute ? ## +[![Discord](https://i.gyazo.com/2115a3ecb258220f5b1a8ebd8c50eb8f.png)](https://discord.gg/Eu3ETSw) + ## You like our work ? ## Sponsor me! -Buy Me a Coffee at ko-fi.com +Buy Me a Coffee at ko-fi.com Become a Patron! -## Achtung! ## +## Warning! ## We are not responsible of any damages caused by bad usage of our source. Please before asking questions or installing this source read this readme and also do a research, google is your friend. If you mess up when installing our source because you didnt follow it, we will laugh at you. A lot. ## Instructions to contribute ## -### Contribution is only possible with Visual Studio 2019 ### -We recommend usage of : +### Disclaimer ### +This project is a community project not for commercial use. The result is to learn and program together for prove the study. + +### Legal ### +This is an independent and unofficial server for educational use ONLY. Using the Project might be against the TOS. + +### Contribution is only possible with Visual Studio 2026 ### +We recommend usage of : * [Roslynator extension](https://github.com/JosefPihrt/Roslynator). * [Resharper](https://www.jetbrains.com/resharper/) ## GUI ## -* A GUI is included in this project. +* A GUI is included in this project. * GUI is only working on windows and require the NosCore database to be loaded -* GUI is not part of the shipped package. -* It's goal is only to visual test pathfinder with a use case +* GUI is not part of the shipped package. +* Its goal is only to visual test pathfinder with a use case -

- -

+## Algorithms ## +* [Brush Fire](./documentation/BrushFireTests.Test_BrushFire.approved.md) +* [Goal-based Pathfinder](./documentation/GoalBasedPathfinderTests.Test_GoalBasedPathfinder.approved.md) +* [Jump Point Search](./documentation/JumpPointSearchPathfinderTests.Test_JumpPointSearchPathfinder.approved.md)