Skip to content

Commit

Permalink
Merge pull request #88 from RobertK66/OBCSW-6-rework-the-readme-md
Browse files Browse the repository at this point in the history
OBCSW-6 Test Jira Link for documentation changes
  • Loading branch information
RobertK66 authored Feb 8, 2024
2 parents 1ab83b4 + 2308730 commit d4d0b33
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 5 deletions.
5 changes: 5 additions & 0 deletions ClimbObc/.project
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
<nature>org.eclipse.xtext.ui.shared.xtextNature</nature>
</natures>
<linkedResources>
<link>
<name>README.md</name>
<type>1</type>
<location>C:/dev/github/obc_1769_core_ado3c/README.md</location>
</link>
<link>
<name>workflows</name>
<type>2</type>
Expand Down
1 change: 1 addition & 0 deletions ClimbObc/src/build.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*
* Created on: 29.01.2022
* Author: Robert
*
*/
//!!!used by github build. Do not remove!!!

23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
obc_1769_core
=============



Implements hardware abstractions and Layer2(3) modules for usage of the OBC
hardware in cubesat projects.



Documentation
-------------
- [Architecture](doc/m00_modules.md) ([Reasoning...](doc/m90_apendix_a.md))
- [Debug Interface](doc/m01_debug_if.md)
- [How to Flash the OBC image](doc/m02_flash_prog.md)
- [OBC Timestamps/RTC and related time formats](doc/m03_systime.md)

- [Architecture](doc/m00_modules.md) ([Reasoning...](doc/m90_apendix_a.md))

- [Debug Interface](doc/m01_debug_if.md)

- [How to Flash the OBC image](doc/m02_flash_prog.md)

- [OBC Timestamps/RTC and related time formats](doc/m03_systime.md)



Build Status
------------
[![Build with MCU Expresso](https://github.com/RobertK66/obc_1769_core/workflows/Build%20with%20MCU%20Expresso/badge.svg)](https://github.com/RobertK66/obc_1769_core/actions/workflows/build.yml) [![OBC Manual as PDF](https://github.com/RobertK66/obc_1769_core/workflows/OBC%20Manual%20as%20PDF/badge.svg)](https://github.com/RobertK66/obc_1769_core/actions/workflows/make-docu.yml) [![Latest Release](https://github.com/RobertK66/obc_1769_core/workflows/Release%20a%20build%20with%20Doku/badge.svg)](https://github.com/RobertK66/obc_1769_core/actions/workflows/release.yml)

<https://github.com/RobertK66/obc_1769_core/actions/workflows/build.yml>
<https://github.com/RobertK66/obc_1769_core/actions/workflows/make-docu.yml>
<https://github.com/RobertK66/obc_1769_core/actions/workflows/release.yml>

Download
--------

[Latest Release](https://github.com/RobertK66/obc_1769_core/releases/latest)

0 comments on commit d4d0b33

Please sign in to comment.