Skip to content

Commit

Permalink
update README status indicators
Browse files Browse the repository at this point in the history
  • Loading branch information
admercs committed Mar 1, 2024
1 parent 7577c87 commit 0697ca4
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# Copyright © 2024 Nervosys, LLC
#----------------------------------------------------------------------------------------

name: "Build and Deploy: Documentation (Doxygen, Sphinx, MkDocs)"
name: "Build and Deploy: Documentation"

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test_format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# Copyright © 2024 Nervosys, LLC
#----------------------------------------------------------------------------------------

name: "Test: Source Code Formatting"
name: "Format: Source Code"

on:
push:
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="./media/images/autonomysim_simple_bw_1000w.png" width="600vw" alt="AutonomySim logo">
</p>

<p align="center" width="100%">
<p align="center" width="100%">
<a alt="Windows Build"
href="https://github.com/nervosys/AutonomySim/actions/workflows/test_windows.yml">
<img src="https://github.com/nervosys/AutonomySim/actions/workflows/test_windows.yml/badge.svg">
Expand All @@ -18,11 +18,22 @@
</a>
</p>

<p align="center" width="100%">
<a alt="Source Formatting"
href="https://github.com/nervosys/AutonomySim/actions/workflows/test_format.yml">
<img src="https://github.com/nervosys/AutonomySim/actions/workflows/test_format.yml/badge.svg">
</a>
<a alt="Documentation Build"
href="https://github.com/nervosys/AutonomySim/actions/workflows/test_docs.yml">
<img src="https://github.com/nervosys/AutonomySim/actions/workflows/test_docs.yml/badge.svg">
</a>
</p>

<h1 align="center">The simulation engine for autonomous systems</h1>

## Announcements

* UNDER CONSTRUCTION: We are updating the build systems. Expect a few bumps in the road.
* Windows now has separate Batch/Command and PowerShell build systems.
* The `autonomysim` Python package has undergone a complete overhaul! `AutonomyLib` is next.
* A new documentation system has been rolled out that covers the Python and C++ APIs.
* `Windows`: all build scripts have been translated from Command/Batch to PowerShell. `Unreal Engine` still generates Batch files and we are still ironing out the bugs.
Expand Down

0 comments on commit 0697ca4

Please sign in to comment.