Skip to content

Commit

Permalink
New Website draft
Browse files Browse the repository at this point in the history
Signed-off-by: Franz-Josef Grosch <schorg@gmail.com>
  • Loading branch information
schorg committed Dec 27, 2021
1 parent b320836 commit 85b55b0
Show file tree
Hide file tree
Showing 17 changed files with 94 additions and 73 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Blech documentation

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Slack chat](https://img.shields.io/static/v1?logo=slack&style=flat&label=slack&color=green&message=blech-lang)](http://chat.blech-lang.org)

Documentation for the Blech embedded programming language.
[Read the documentation on blech-lang.org](https://www.blech-lang.org)
Expand Down Expand Up @@ -134,7 +134,7 @@ Give GitHub some time to deploy the content and open the Blech site on:

* https://blech-lang.org
* https://www.blech-lang.org
* https://boschresearch.github.io/blech-doc
* https://blech-lang.github.io/blech-doc


#### Check for broken links on the website
Expand Down Expand Up @@ -166,8 +166,6 @@ The [documentation for the Docsy Theme](https://www.docsy.dev/docs/adding-conten

Creating a blog post is easy. The [Docsy example site shows how to do this](https://example.docsy.dev/blog/2018/10/06/easy-documentation-with-docsy/).

Additional information can be found in the [TechOS theme documentation](https://temp.bep.is/td/docs/theme-documentation/).




Expand Down
6 changes: 6 additions & 0 deletions website/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Theme colors
$dark: #150734;
$primary: #0F2557;
$secondary: #28559A;
$light: #4B9FE1;
$info: #63BCE5;
1 change: 1 addition & 0 deletions website/assets/scss/main.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
@import "_variables_project";
@import "../../themes/docsy/assets/scss/main";

@import "opt-in";
18 changes: 9 additions & 9 deletions website/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ privacy_policy = "/about/privacy-policy/"
version_menu = "Releases"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/boschresearch/blech-doc"
github_repo = "https://github.com/blech-lang/blech-doc"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/boschresearch/blech"
github_project_repo = "https://github.com/blech-lang/blech"

# Specify a value here if your content directory is not in your repo's root directory
github_subdir = "website"
Expand Down Expand Up @@ -156,8 +156,8 @@ footer_about_disable = false
[params.ui.feedback]
enable = false
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Glad to hear it! Please <a href="https://github.com/boschresearch/blech-doc/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/boschresearch/blech-doc/issues/new">tell us how we can improve</a>.'
yes = 'Glad to hear it! Please <a href="https://github.com/blech-lang/blech-doc/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/blech-lang/blech-doc/issues/new">tell us how we can improve</a>.'

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
Expand All @@ -175,22 +175,22 @@ no = 'Sorry to hear that. Please <a href="https://github.com/boschresearch/blech
name ="Twitter @BlechLanguage"
url = "https://twitter.com/BlechLanguage"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name ="Documentation on GitHub"
url = "https://github.com/boschresearch/blech-doc"
url = "https://github.com/blech-lang/blech-doc"
icon = "fas fa-book"
desc = "Documentation is collected here!"
desc = "Documentation is collected here!"

# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "Blech compiler on Github"
url = "https://github.com/boschresearch/blech"
url = "https://github.com/blech-lang/blech"
icon = "fab fa-github"
desc = "Compiler development takes place here!"
[[params.links.developer]]
name = "Blech tools on Github"
url = "https://github.com/boschresearch/blech-tools"
url = "https://github.com/blech-lang/blech-tools"
icon = "fas fa-tools"
desc = "Tool development takes place here!"
[[params.links.developer]]
Expand Down
29 changes: 22 additions & 7 deletions website/content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

+++

{{< blocks/cover title="The Blech language" image_anchor="top" height="full" color="primary" >}}
{{< blocks/cover title="The Blech language" image_anchor="top" height="auto" color="primary" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Documentation <i class="fas fa-arrow-alt-circle-right ml-2"></i>
Expand All @@ -22,29 +22,43 @@



{{< blocks/section color="dark">}}

{{< blocks/feature-code title="Look and Feel">}}
<div style="white-space: pre; font-size: smaller; font-family: SFMono-Regular, Menlo, Monaco, Consolas, Liberation Mono, Courier New, monospace;" class=""><br class=""><div class=""><span style="color: rgb(63, 151, 223);" class="">struct</span> Display</div><div class=""> <span style="color: rgb(63, 151, 223);" class="">var</span> hundredth: <span style="color: rgb(63, 151, 223);" class="">int32</span> </div><div class=""> <span style="color: rgb(63, 151, 223);" class="">var</span> seconds: <span style="color: rgb(63, 151, 223);" class="">int32</span></div><div class=""> <span style="color: rgb(63, 151, 223);" class="">var</span> minutes: <span style="color: rgb(63, 151, 223);" class="">int32</span></div><div class=""><span style="color: rgb(63, 151, 223);" class="">end</span></div><br class=""><div class=""><span style="color: rgb(162, 86, 55);" class="">@[CFunction(binding = "showConsole", header = "runtimeLAPFAST.h")]</span></div><div class=""><span style="color: rgb(63, 151, 223);" class="">extern</span> <span style="color: rgb(63, 151, 223);" class="">function</span> show (this: Display)</div><br class=""><div class=""><span style="color: rgb(63, 151, 223);" class="">function</span> writeTicksToDisplay (ticks: <span style="color: rgb(63, 151, 223);" class="">int32</span>) (display: Display)</div><div class=""> <span style="color: rgb(63, 151, 223);" class="">let</span> seconds = ticks / 100</div><div class=""> display.minutes = seconds / 60</div><div class=""> display.seconds = seconds - 60 * display.minutes</div><div class=""> display.hundredth = ticks - 100 * seconds</div><div class=""><span style="color: rgb(63, 151, 223);" class="">end</span></div><br class=""><div class=""><span style="color: rgb(63, 151, 223);" class="">activity</span> Measurement (isPressedResetLap: <span style="color: rgb(63, 151, 223);" class="">bool</span>) </div><div class=""> (totalTime: <span style="color: rgb(63, 151, 223);" class="">int32</span>, lastLap: <span style="color: rgb(63, 151, 223);" class="">int32</span>, display: Display)</div><div class=""><span style="color: rgb(157, 78, 150);" class=""> cobegin</span><span style="color: rgb(146, 205, 120);" class=""> // run</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">repeat</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">await</span> <span style="color: rgb(63, 151, 223);" class="">true</span></div><div class=""> totalTime = totalTime + 1</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">end</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">with</span><span style="color: rgb(146, 205, 120);" class=""> // lap</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">repeat</span></div><div class=""> <span style="color: rgb(146, 205, 120);" class="">// show total time every tick</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">repeat</span></div><div class=""> writeTicksToDisplay(totalTime)(display)</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">await</span> <span style="color: rgb(63, 151, 223);" class="">true</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">until</span> isPressedResetLap <span style="color: rgb(157, 78, 150);" class="">end</span></div><br class=""><div class=""> <span style="color: rgb(146, 205, 120);" class="">// calculate lap and update display once</span></div><div class=""> <span style="color: rgb(63, 151, 223);" class="">let</span> lapTime = totalTime - lastLap</div><div class=""> lastLap = totalTime</div><div class=""> writeTicksToDisplay(lapTime)(display) </div><div class=""> <span style="color: rgb(157, 78, 150);" class="">await</span> isPressedResetLap</div><div class=""> <span style="color: rgb(146, 205, 120);" class="">// back to total time</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">end</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">end</span></div><div class=""><span style="color: rgb(63, 151, 223);" class="">end</span></div></div>
{{< /blocks/feature-code >}}


{{< blocks/feature-code color="dark" url="/lecture-blech.pdf">}}
<div style="white-space: pre; font-size: smaller; font-family: SFMono-Regular, Menlo, Monaco, Consolas, Liberation Mono, Courier New, monospace;" class=""><div class=""><span style="color: rgb(63, 151, 223);" class="">activity</span> StopWatchController (isPressedStartStop: <span style="color: rgb(63, 151, 223);" class="">bool</span>, <br class=""> isPressedResetLap: <span style="color: rgb(63, 151, 223);" class="">bool</span>) </div><div class=""> (display: Display)</div><div class=""> <span style="color: rgb(63, 151, 223);" class="">var</span> totalTime: <span style="color: rgb(63, 151, 223);" class="">int32</span> </div><div class=""> <span style="color: rgb(63, 151, 223);" class="">var</span> lastLap: <span style="color: rgb(63, 151, 223);" class="">int32</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">repeat</span></div><div class=""> <span style="color: rgb(146, 205, 120);" class="">// init</span></div><div class=""> totalTime = 0</div><div class=""> lastLap = 0</div><div class=""> writeTicksToDisplay(totalTime)(display)</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">await</span> isPressedStartStop <span style="color: rgb(146, 205, 120);" class="">// transition init -&gt; run</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">repeat</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">when</span> isPressedStartStop <span style="color: rgb(157, 78, 150);" class="">abort</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">run</span> Measurement(isPressedResetLap)<br class=""> (totalTime, lastLap, display)</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">end</span></div><div class=""> <span style="color: rgb(146, 205, 120);" class="">// stop, show total time and wait</span></div><div class=""> writeTicksToDisplay(totalTime)(display)</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">await</span> isPressedStartStop <span style="color: rgb(63, 151, 223);" class="">or</span> isPressedResetLap</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">until</span> isPressedResetLap <span style="color: rgb(157, 78, 150);" class="">end</span> <span style="color: rgb(146, 205, 120);" class="">// repeat if StartStop was pressed</span></div><div class=""> <span style="color: rgb(146, 205, 120);" class="">// back to init if ResetLap was pressed</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">end</span></div><div class=""><span style="color: rgb(63, 151, 223);" class="">end</span></div><br class=""><div class=""><span style="color: rgb(162, 86, 55);" class="">@[EntryPoint]</span></div><div class=""><span style="color: rgb(63, 151, 223);" class="">activity</span> Main (isPressedStartStop: <span style="color: rgb(63, 151, 223);" class="">bool</span>, isPressedReset: <span style="color: rgb(63, 151, 223);" class="">bool</span>)</div><div class=""> <span style="color: rgb(63, 151, 223);" class="">var</span> display: Display</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">cobegin</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">run</span> StopWatchController(isPressedStartStop, isPressedReset)<br class=""> (display)</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">with</span> </div><div class=""> <span style="color: rgb(146, 205, 120);" class="">// render display in every tick</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">repeat</span></div><div class=""> show(display)</div><div class=""> <span style="color: rgb(157, 78, 150);" class="">await</span> <span style="color: rgb(63, 151, 223);" class="">true</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">end</span></div><div class=""> <span style="color: rgb(157, 78, 150);" class="">end</span></div><div class=""><span style="color: rgb(63, 151, 223);" class="">end</span></div><br class=""></div>
{{< /blocks/feature-code >}}

{{< /blocks/section >}}


{{% blocks/lead color="primary" %}}
Blech is a *synchronous* programming language for embedded, reactive, realtime-critical software.

It allows writing reactive subprograms and combining them both sequentially and concurrently.
Blech compiles to *clean* C, which may be integrated into existing projects or simulation frameworks.

The German word _Blech_ roughly translates to _bare metal_.
Blech programs can run directly on _the Blech_ on pretty much any embedded device.
Blech started at [<span style="color: #63BCE5">Bosch Research</span>](https://github.com/boschresearch/blech) and [<span style="color: #63BCE5">now evolves as a community-driven open-source project</span>](/blog/2021/12/20/the-blech-abides/).

Read our introductory blog post to learn more on [the purpose of Blech](/blog/2020/05/27/the-purpose-of-blech/).
The language is called _Blech_ - which translates to sheet metal - since _Metal_ was already taken. It expresses that Blech programs can run directly on _the Blech_ on pretty much any embedded device.

Read our introductory blog post to learn more on [<span style="color: #63BCE5">the purpose of Blech</span>](/blog/2020/05/27/the-purpose-of-blech/).

{{% /blocks/lead %}}


{{< blocks/section color="dark" >}}
{{< blocks/section color="secondary" >}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="/docs/contributing/" %}}
We do a [Pull Request](https://github.com/boschresearch/blech/pulls) contributions workflow on **GitHub**. New contributors are always welcome!
We do a [Pull Request](https://github.com/blech-lang/blech/pulls) contributions workflow on **GitHub**. New contributors are always welcome!
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-slack" title="Discuss with the Blech developers!" url="https://blech-lang.slack.com/" %}}
{{% blocks/feature icon="fab fa-slack" title="Discuss with the Blech developers!" url="http://slack.blech-lang.org" %}}
Exchange ideas on the development and evolution of Blech; its compiler, tools and documentation.
{{% /blocks/feature %}}

Expand All @@ -55,3 +69,4 @@
{{< /blocks/section >}}



8 changes: 4 additions & 4 deletions website/content/en/about/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ type: "docs"

This website makes the Blech language documentation, the Blech compiler, and the Blech tools accessible.

* The website is a [**GitHub project page**](https://help.github.com/en/github/working-with-github-pages/about-github-pages) [`boschresearch.github.io/blech-doc`](https://boschresearch.github.io/blech-doc).
* The [**GitHub organization**](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-organizations) is [`boschresearch`](https://github.com/boschresearch)
* The GitHub project for this website is [`blech-doc`](https://github.com/boschresearch/blech-doc).
* The website is a [**GitHub project page**](https://help.github.com/en/github/working-with-github-pages/about-github-pages) [`blech-lang.github.io/blech-doc`](https://blech-lang.github.io/blech-doc).
* The [**GitHub organization**](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-organizations) is [`blech-lang`](https://github.com/blech-lang)
* The GitHub project for this website is [`blech-doc`](https://github.com/blech-lang/blech-doc).
* The website is hosted on GitHub's [`github.io`](https://github.io) domain.

The website is accessible via
1. the subdomain http://www.blech-lang.org,
2. the apex domain http://blech-lang.org, and
3. the GitHub pages site https://boschresearch.github.io/blech-doc.
3. the GitHub pages site https://blech-lang.github.io/blech-doc.

The apex domain and the GitHub pages site redirect to the subdomain.

Expand Down
41 changes: 0 additions & 41 deletions website/content/en/about/corporate-information.md

This file was deleted.

32 changes: 32 additions & 0 deletions website/content/en/about/legal-notice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Legal notice"
linkTitle: "Legal notice"
type: "docs"
weight: 10
---


### Name and address

blech-lang.org
c/o Franz-Josef Grosch
Margeritenstraße 4
71272 Renningen
Germany

### Your contact at blech-lang.org

<i class="fas fa-envelope"></i> [webmaster@blech-lang.org](mailto:webmaster@blech-lang.org)

### Responsible in accordance with section 18 II of Germany’s Interstate Treaty on Media (MStV)

blech-lang.org
c/o Franz-Josef Grosch
Margeritenstraße 4
71272 Renningen
Germany

### Legal disclaimer ###
The contents of these pages were prepared with utmost care. Nonetheless, we cannot assume liability for the timeless accuracy and completeness of the information.

Our website contains links to external websites. As the contents of these third-party websites are beyond our control, we cannot accept liability for them. Responsibility for the contents of the linked pages is always held by the provider or operator of the pages.
Loading

0 comments on commit 85b55b0

Please sign in to comment.