diff --git a/docs/api/index.md b/docs/api/index.md deleted file mode 100644 index 78dc9c0..0000000 --- a/docs/api/index.md +++ /dev/null @@ -1,2 +0,0 @@ -# PLACEHOLDER -TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/docs/articles/intro.md b/docs/articles/intro.md deleted file mode 100644 index c0478ce..0000000 --- a/docs/articles/intro.md +++ /dev/null @@ -1 +0,0 @@ -# Add your introductions here! diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml deleted file mode 100644 index ff89ef1..0000000 --- a/docs/articles/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Introduction - href: intro.md diff --git a/docs/dev.md b/docs/dev.md new file mode 100644 index 0000000..a25326d --- /dev/null +++ b/docs/dev.md @@ -0,0 +1,3 @@ +# Development + +To do. diff --git a/docs/docfx.json b/docs/docfx.json index 5ad1be8..f961109 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -24,14 +24,11 @@ "content": [ { "files": [ - "api/**.yml", - "api/index.md" + "api/**.yml" ] }, { "files": [ - "articles/**.md", - "articles/**/toc.yml", "toc.yml", "*.md" ] @@ -44,10 +41,15 @@ ], "output": "_site", "globalMetadata": { + "_appFooter": "Copyright © 2023 Nuno Fachada and contributors. Generated with DocFX and DocFX Material.", "_appTitle": "LibGameAI", "_appLogoPath": "images/logo.svg", "_appFaviconPath": "images/logo.svg", - "_enableSearch": "true" + "_enableSearch": "true", + "_gitContribute": { + "repo": "https://github.com/nunofachada/libgameai" + }, + "_gitUrlPattern": "github" }, "globalMetadataFiles": [], "fileMetadataFiles": [], @@ -56,7 +58,7 @@ "modern", "templates/material" ], - "postProcessors": [], + "postProcessors": ["ExtractSearchIndex"], "keepFileLink": false, "disableGitFeatures": false } diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 0000000..0da178a --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,6 @@ +# Usage examples + +This page will be expanded in the future. For now, check out LibGameAI being +used in these educational [Game AI Prototypes]. + +[Game AI Prototypes]:https://github.com/nunofachada/game-ai-prototypes \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 3ae2506..587c264 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,38 @@ -# This is the **HOMEPAGE**. -Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. -## Quick Start Notes: -1. Add images to the *images* folder if the file is referencing an image. +# LibGameAI + +A .NET Standard 2.1 library of AI algorithms for video games with a focus on +education. + +## Library components + +* [Decision trees](lib/DecisionTrees) +* [Finite state machines](lib/FSMs) +* [N-grams](lib/NGrams) +* [Naive Bayes classifier](lib/NaiveBayes) +* [Path finding algorithms](lib/PathFinding) +* [PCG](lib/PCG) +* [PRNG](lib/PRNG) +* [QRNG](lib/QRNG) +* [Utils](lib/Util) + +## Status & Usage + +This is very much a work in progress, and should be considered to be at an alpha +stage of development. + +This library is currently used in the educational [Game AI Prototypes]. + +## Reference + +If you use or mention this software in your work, please cite the following +reference: + +- Fachada, N., Barreiros, F.F., Lopes, P., & Fonseca, M. (2023, August). + Active Learning Prototypes for Teaching Game AI. In *2023 IEEE Conference on + Games (CoG)* (pp. TBD). IEEE. + +## License + +[MIT](LICENSE) + +[Game AI Prototypes]:https://github.com/nunofachada/game-ai-prototypes \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml index b51ebfe..40fff9f 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -1,5 +1,9 @@ -- name: Articles - href: articles/ -- name: API Documentation +- name: Home + href: index.md +- name: Usage examples + href: examples.md +- name: Development + href: dev.md +- name: API Reference href: api/ - homepage: api/index.md +