Attempt to decouple docs and test jobs

This commit is contained in:
Daniel Lovell
2024-09-30 02:05:26 -07:00
parent 765f3983f3
commit e9d3f2b388
4 changed files with 94 additions and 73 deletions

View File

@@ -1,18 +1,17 @@
module.exports = {
title: 'Micromissiles Unity Project',
description: 'Documentation for the Micromissiles Unity project',
themeConfig: {
navbar: [
{ text: 'Home', link: '/' },
{ text: 'Keybinds and Controls', link: '/Keybinds_and_Controls.html' },
{ text: 'Simulation Configuration Guide', link: '/Simulation_Config_Guide.html' },
{ text: 'Simulation Logging', link: '/Simulation_Logging.html' },
],
sidebar: 'auto',
},
extendsPageData: (pageData) => {
if (pageData.relativePath === 'README.md') {
pageData.frontmatter.home = true;
}
},
}
title: 'Micromissiles Unity Project',
description: 'Documentation for the Micromissiles Unity project',
base: '/micromissiles-unity/',
themeConfig: {
navbar: [
{ text: 'Home', link: '/' },
{ text: 'Keybinds and Controls', link: '/Keybinds_and_Controls.html' },
{ text: 'Simulation Configuration Guide', link: '/Simulation_Config_Guide.html' },
{ text: 'Simulation Logging', link: '/Simulation_Logging.html' },
{ text: 'Coverage Reports', link: '/coverage/' }, // Link to coverage reports
],
sidebar: 'auto',
},
// Add this to ensure INDEX.md is used as the home page
patterns: ['INDEX.md', '**/*.md', '**/*.vue'],
}

39
docs/INDEX.md Normal file
View File

@@ -0,0 +1,39 @@
---
home: true
heroImage: /images/logo.png
heroText: Micromissiles Unity Project
tagline: Documentation for the Micromissiles Unity project
actionText: Get Started →
actionLink: /Keybinds_and_Controls.html
features:
- title: Swarm-on-swarm simulations
details: This project models swarm-on-swarm point defense scenarioswith multiple missile and drone models.
- title: Customizable Scenarios
details: Create and modify various engagement scenarios.
- title: Detailed Analysis
details: Comprehensive logging and data analysis tools.
---
# Micromissiles Unity Project
![Sim Salvo Animation](/images/sim_salvo_animation.gif)
## Quick Start
We generate pre-built standalone binaries for Windows and Mac users from the `release` branch. These binaries are intended for non-development users who just want to run the application and modify a few configurations along the way.
You can find the latest release [here](https://github.com/PisterLab/micromissiles-unity/releases/latest).
### Windows
1. Download the zip file for Windows: `micromissiles-<version>-windows_x86_64.zip`.
2. Unzip the zip file. The zip file should contain a single directory called `micromissiles-<version>-windows_x86_64`.
3. In the `micromissiles-<version>-windows_x86_64` directory, run `micromissiles-<version>-StandaloneWindows64.exe`.
### Mac
1. Download the tarball file for Darwin: `micromissiles-<version>-darwin.tar.gz`.
2. Untar the tarball. The tarball should contain a single directory called `micromissiles-<version>-darwin`.
3. In the `micromissiles-<version>-darwin` directory, run the app file.
For more detailed information, please refer to our [documentation pages](/Keybinds_and_Controls.html).