Skip to content

Commit

Permalink
Added Readme
Browse files Browse the repository at this point in the history
- Updated siunitx \SI -> \qty
- Added manual to landing page
  • Loading branch information
PatrickBaus committed Jun 10, 2024
1 parent 2071d92 commit 94c95f8
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ jobs:
if: github.event.action != 'published'
uses: actions/upload-artifact@v4
with:
name: datasheet
name: manual
path: ${{ steps.output-filename.outputs.value }}

- name: Append PDF as an asset
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![Build manufacturing files](https://github.com/TU-Darmstadt-APQ/RedPitaya-Lockbox/actions/workflows/ci.yml/badge.svg)](https://github.com/TU-Darmstadt-APQ/RedPitaya-Lockbox/actions/workflows/ci.yml)
[![Build manual](https://github.com/TU-Darmstadt-APQ/RedPitaya-Lockbox/actions/workflows/manual.yml/badge.svg)](https://github.com/TU-Darmstadt-APQ/RedPitaya-Lockbox/actions/workflows/manual.yml)

Digital Controller for Laser Frequency Stabilization
===================
Expand Down Expand Up @@ -28,6 +29,7 @@ The design files can be found on the [releases](../../releases) page and include
- Gerber files
- Pick & place position files
- Bill of materials as a CSV file and also as an interactive HTML version
- User manual

The latest revision of those files can be found [here](../../releases/latest).

Expand Down
3 changes: 3 additions & 0 deletions manual/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
User Manual
===================
This folder contains the source files for the user and assembly manual. For a compiled PDF check out the [releases](../../../releases) page.
Loading

0 comments on commit 94c95f8

Please sign in to comment.