Skip to content

Commit 85b55b0

Browse files
committed
New Website draft
Signed-off-by: Franz-Josef Grosch <schorg@gmail.com>
1 parent b320836 commit 85b55b0

17 files changed

Lines changed: 94 additions & 73 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Blech documentation
22

3-
[![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)
3+
[![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)
44

55
Documentation for the Blech embedded programming language.
66
[Read the documentation on blech-lang.org](https://www.blech-lang.org)
@@ -134,7 +134,7 @@ Give GitHub some time to deploy the content and open the Blech site on:
134134
135135
* https://blech-lang.org
136136
* https://www.blech-lang.org
137-
* https://boschresearch.github.io/blech-doc
137+
* https://blech-lang.github.io/blech-doc
138138
139139
140140
#### Check for broken links on the website
@@ -166,8 +166,6 @@ The [documentation for the Docsy Theme](https://www.docsy.dev/docs/adding-conten
166166
167167
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/).
168168
169-
Additional information can be found in the [TechOS theme documentation](https://temp.bep.is/td/docs/theme-documentation/).
170-
171169
172170
173171
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// Theme colors
2+
$dark: #150734;
3+
$primary: #0F2557;
4+
$secondary: #28559A;
5+
$light: #4B9FE1;
6+
$info: #63BCE5;

website/assets/scss/main.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
@import "_variables_project";
12
@import "../../themes/docsy/assets/scss/main";
23

34
@import "opt-in";

website/config.toml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ privacy_policy = "/about/privacy-policy/"
120120
version_menu = "Releases"
121121

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

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

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

185185
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
186186
[[params.links.developer]]
187187
name = "Blech compiler on Github"
188-
url = "https://github.com/boschresearch/blech"
188+
url = "https://github.com/blech-lang/blech"
189189
icon = "fab fa-github"
190190
desc = "Compiler development takes place here!"
191191
[[params.links.developer]]
192192
name = "Blech tools on Github"
193-
url = "https://github.com/boschresearch/blech-tools"
193+
url = "https://github.com/blech-lang/blech-tools"
194194
icon = "fas fa-tools"
195195
desc = "Tool development takes place here!"
196196
[[params.links.developer]]

website/content/en/_index.html

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
+++
66

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

2323

2424

25+
{{< blocks/section color="dark">}}
26+
27+
{{< blocks/feature-code title="Look and Feel">}}
28+
<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>
29+
{{< /blocks/feature-code >}}
30+
31+
32+
{{< blocks/feature-code color="dark" url="/lecture-blech.pdf">}}
33+
<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>
34+
{{< /blocks/feature-code >}}
35+
36+
{{< /blocks/section >}}
37+
2538

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

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

32-
The German word _Blech_ roughly translates to _bare metal_.
33-
Blech programs can run directly on _the Blech_ on pretty much any embedded device.
45+
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/).
3446

35-
Read our introductory blog post to learn more on [the purpose of Blech](/blog/2020/05/27/the-purpose-of-blech/).
47+
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.
48+
49+
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/).
3650

3751
{{% /blocks/lead %}}
3852

3953

40-
{{< blocks/section color="dark" >}}
54+
{{< blocks/section color="secondary" >}}
4155

4256

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

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

@@ -55,3 +69,4 @@
5569
{{< /blocks/section >}}
5670

5771

72+

website/content/en/about/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ type: "docs"
99

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

12-
* 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).
13-
* The [**GitHub organization**](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-organizations) is [`boschresearch`](https://github.com/boschresearch)
14-
* The GitHub project for this website is [`blech-doc`](https://github.com/boschresearch/blech-doc).
12+
* 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).
13+
* 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)
14+
* The GitHub project for this website is [`blech-doc`](https://github.com/blech-lang/blech-doc).
1515
* The website is hosted on GitHub's [`github.io`](https://github.io) domain.
1616

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

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

website/content/en/about/corporate-information.md

Lines changed: 0 additions & 41 deletions
This file was deleted.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Legal notice"
3+
linkTitle: "Legal notice"
4+
type: "docs"
5+
weight: 10
6+
---
7+
8+
9+
### Name and address
10+
11+
blech-lang.org
12+
c/o Franz-Josef Grosch
13+
Margeritenstraße 4
14+
71272 Renningen
15+
Germany
16+
17+
### Your contact at blech-lang.org
18+
19+
<i class="fas fa-envelope"></i> [webmaster@blech-lang.org](mailto:webmaster@blech-lang.org)
20+
21+
### Responsible in accordance with section 18 II of Germany’s Interstate Treaty on Media (MStV)
22+
23+
blech-lang.org
24+
c/o Franz-Josef Grosch
25+
Margeritenstraße 4
26+
71272 Renningen
27+
Germany
28+
29+
### Legal disclaimer ###
30+
The contents of these pages were prepared with utmost care. Nonetheless, we cannot assume liability for the timeless accuracy and completeness of the information.
31+
32+
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.

0 commit comments

Comments
 (0)