Skip to content

Commit

Permalink
Merge pull request #2 from NoMore201/feature/website
Browse files Browse the repository at this point in the history
Add material mkdocs docs with github actions trigger
  • Loading branch information
NoMore201 authored Dec 11, 2024
2 parents 8816466 + c096fe8 commit 00b3fd1
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Documentation
on:
push:
branches:
- main
paths:
- docs/**
- mkdocs.yml
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
25 changes: 25 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Changelog

## 11.3.1-20241211

- toolchain: Added QEMU 9.2.0 static executable to the toolchain, compiled with
tricore support enabled
- script: Switch build script to a GNU autoconf based solution, insipired by
[RiscV toolchain repository](https://github.com/riscv-collab/riscv-gnu-toolchain)
- release: Switched from commit SHA based release number to date release number. From now on, all releases will be tagged as 11.3.1-<date> to better recognize different versions

## 11.3.1-5e4ca74

- binutils: Rename padding data, check for null pointer when dereferencing
- script: Use -gdwarf-3 option for win32 build

## 11.3.1-258811c

- binutils: Fix issue in extended map table showing garbage
data for memory sections
- gcc: Fix build for macOS
- gcc: Add support for Tricore TC33x family MCUs

## 11.3.1-6eca707

- binutils: Fix issue in LD linker that caused crashes with some linker scripts
25 changes: 25 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Tricore GNU toolchain

Free and open source cross-compiler toolchain for AURIX™ TriCore™
microcontrollers. It supports TriCore™ architecture from 1.3 up to 1.8 and
includes the following software:

- GCC 11.3.1
- Binutils 2.40
- libc based on Cygwin Newlib
- QEMU 9.2.0

> This repository is a downstream of
> [EEESlab/tricore-gcc-toolchain-11.3.0](https://github.com/EEESlab/tricore-gcc-toolchain-11.3.0)
> that aims to be a playground for new features and improvements with a faster
> developement process and automated release management. All the meaningful
> changes will be contributed back to upstream repository
## Install

Grab the latest release from
[GitHub releases](https://github.com/NoMore201/tricore-gcc-toolchain/releases).
To build the toolchain manually from sources, please refer to the main
[README.md](https://github.com/NoMore201/tricore-gcc-toolchain/blob/main/README.md).


11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
site_name: Tricore GNU Toolchain
repo_url: https://github.com/NoMore201/tricore-gcc-toolchain
repo_name: tricore-gcc-toolchain
theme:
name: material

plugins: []

nav:
- Home: index.md
- Changelog: changelog.md

0 comments on commit 00b3fd1

Please sign in to comment.