diff --git a/README.md b/README.md index b7f015a6..f842b2f6 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,28 @@ ![logo64](./docs/assets/22-09-2023/logo64.png) -# Visualiser +# Posthoc Visualiser -Visualise pathfinding search and more. +[Open Posthoc](https://http://posthoc.pathfinding.ai/) -[Open Visualiser](https://path-visualiser.github.io/app) +**Posthoc** is a way to build quick-and-dirty visualisations ✨ for sequential decision-making algorithms, such as search algorithms 🚀. -## Start Development Server +![Alt text](./docs/assets/screenshot.png) -```bash -git clone https://github.com/path-visualiser/app -cd ./app -npm i -npm start -``` +It's easy to get started. + +1. Print logs as [search traces](https://path-visualiser.github.io/docs/search-trace) +2. Load those into the [Posthoc visualiser](https://path-visualiser.github.io/docs/category/posthoc-visualiser) +3. Voila! + +## Documentation + +[View documentation](https://path-visualiser.github.io) ## Changelog -[View Changelog](./docs/changelog.md) +[View changelog](./docs/changelog.md) ## Releases -[View Releases](https://github.com/path-visualiser/app/releases) +[View releases](https://github.com/path-visualiser/app/releases) diff --git a/client/src/components/title-bar/TitleBar.tsx b/client/src/components/title-bar/TitleBar.tsx index baadac04..8773478d 100644 --- a/client/src/components/title-bar/TitleBar.tsx +++ b/client/src/components/title-bar/TitleBar.tsx @@ -17,7 +17,7 @@ import { startCase } from "lodash"; import PopupState, { bindMenu, bindTrigger } from "material-ui-popup-state"; import { nanoid as id } from "nanoid"; import logo from "public/logo512.png"; -import { docs, repository, version } from "public/manifest.json"; +import { changelog, repository, version, docs } from "public/manifest.json"; import { ReactElement, ReactNode, @@ -193,17 +193,13 @@ export const TitleBar = () => { name: "Changelog", key: "changelog", action: () => - open(`${docs}/changelog-${version}.md`, "_blank"), + open(`${changelog}/changelog-${version}.md`, "_blank"), }, { type: "action", name: "Documentation", key: "documentation", - action: () => - open( - `https://path-visualiser.github.io/docs/overview/`, - "_blank" - ), + action: () => open(docs, "_blank"), }, ], }, diff --git a/client/src/pages/ExplorePage.tsx b/client/src/pages/ExplorePage.tsx index 3634cf8a..5ba6bc2e 100644 --- a/client/src/pages/ExplorePage.tsx +++ b/client/src/pages/ExplorePage.tsx @@ -37,7 +37,7 @@ import { } from "lodash"; import { map as mapAsync } from "promise-tools"; import { FeatureDescriptor } from "protocol/FeatureQuery"; -import { homepage, name } from "public/manifest.json"; +import { docs, name } from "public/manifest.json"; import { CSSProperties, ReactNode, useMemo, useState } from "react"; import { useAsync } from "react-async-hook"; import { useLoadingState } from "slices/loading"; @@ -408,7 +408,7 @@ export function ExplorePage({ template: Page }: PageContentProps) { documentation instead.