Skip to content

Add Helloworld documentation #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
radu1265 wants to merge 6 commits into
base: cdl-47
Choose a base branch
from
Open

Add Helloworld documentation #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
25369dc
README: Improve description of helloworld task
razvand Mar 22, 2025
2ce9746
Update README.md
AntonieValentin Oct 24, 2025
8732a59
Create helloworld.md
Oct 25, 2025
e6eb789
Add 'Hello, World!' programs for multiple languages
radu1265 Oct 25, 2025
90fdbea
Refactor Helloworld programs documentation
radu1265 Oct 25, 2025
a974819
Refactor Helloworld documentation
radu1265 Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,17 @@ Create the `helloworld.md` file that will generate that precise GitHub view.
Make sure you do the following:

1. Start by creating a branch where you do your work.
Use `helloworld` for the branch name:

```console
git checkout -b helloworld
```

This will be the branch **from** where you will create a pull request.
As usual, the future pull request will target your assigned branch in the [upstream repository](https://github.com/rosedu/workshop-markdown).

1. Copy-paste contents from the PDF file.
Do not write programs by hand.
Open the `helloworld-print.pdf` file in a PDF viewer, select text, copy in the `helloworld.md` file.

1. Use correct syntax items for typewriter format, links to sections, code snippet format, tables.
See [the GitHub Markdown spec](https://github.github.com/gfm/).
Expand All @@ -195,21 +201,18 @@ Make sure you do the following:

After each push, check the GitHub view of the work branch in your fork of the GitHub repository.

1. After completing the task, submit the `helloworld.md` Markdown file as part of a pull request.

Follow the instructions above to create the pull request.
Make sure you have good commit messages and a good pull request description.
Check the contents of the `helloworld.md` file on your GitHub fork and see if it is now rendered correctly.

Target the pull request **to** your assigned branch.
1. After completing the task, submit the `helloworld.md` Markdown file as part of a pull request.

Ask the instructors to review your pull request.
Make updates as required.
Have your pull request approved and merged on top of your assigned branch.
Follow the instructions above to create the pull request.
Make sure you have good commit messages and a good pull request description.

Check the GitHub web view of the [upstream repository](https://github.com/rosedu/workshop-markdown) for your assigned branch.
Click on the button with `main` (the branch button) and select your branch.
Target the pull request **to** your assigned branch.

Check the contents of the `helloworld.md` file and see if it is now rendered correctly.
1. Ask the instructors to review your pull request.
Make updates as required.
Have your pull request approved and merged on top of your assigned branch.

### Clean Up After Pull Request

Expand Down
168 changes: 168 additions & 0 deletions helloworld.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
# Helloworld Programs

![Hello, World!](https://github.com/radu1265/workshop-markdown/blob/helloworld/helloworld.png)


We list below Helloworld programs for different programming languages, i.e. programs that print "Hello, World!"
. The
specified compiler or interpreter is required for each programming languages.
The table below summarizes the programs:
| Language | Language (Spec / Home) | Site Section | Build / Run Toolchain | Debian / Ubuntu Packages |
|-----------|------------------------|---------------|----------------------|---------------------------|
| C | [The Standard - C](https://www.open-std.org/jtc1/sc22/wg14/) | C | GCC | ⁠ build-essential ⁠ |
| C++ | [The Standard - C++](https://isocpp.org/) | C++ | GCC / G++ | ⁠ build-essential, g++ ⁠ |
| Dlang | [D Programming Language: Home](https://dlang.org/) | Dlang | GCC / GDC | ⁠ build-essential, gdc ⁠ |
| Go | [The Go Programming Language](https://golang.org/) | Go | Go | ⁠ golang ⁠ |
| Rust | [Rust Programming Language](https://www.rust-lang.org/) | Rust | Rust (Crate) | ⁠ rustlang ⁠ |
| Java | [Java Programming Language](https://www.java.com/) | Java | JDK | ⁠ openjdk-17-jdk ⁠ |
| x86_64 Assembly | [x86 and amd64 Instruction Set Reference](https://www.felixcloutier.com/x86/) | Assembly | GCC / GAS | ⁠ build-essential ⁠ |
| ARM64 Assembly | [Arm A64 Instruction Set (AArch64)](https://developer.arm.com/documentation/ddi0602/2024-03/Base-Instructions?lang=en) | Assembly | GCC / GAS | ⁠ build-essential ⁠ |
| Bash | [Bash Reference Manual](https://www.gnu.org/software/bash/manual/) | Bash | Bash | ⁠ bash ⁠ |
| Python | [Welcome to Python.org](https://www.python.org/) | Python | Python | ⁠ python ⁠ |
| Ruby | [Ruby Programming Language](https://www.ruby-lang.org/) | Ruby | Ruby | ⁠ ruby ⁠ |
| PHP | [PHP: Hypertext Preprocessor](https://www.php.net/) | PHP | PHP | ⁠ php ⁠ |
| Perl | [The Perl Programming Language](https://www.perl.org/) | Perl | Perl | ⁠ perl ⁠ |
| Lua | [The Programming Language Lua](https://www.lua.org/) | Lua | Lua | ⁠ lua ⁠ |

# C

```C
#include <stdio.h>
int main(void)
{
puts("Hello, World!");
return 0;
}
Build with:
gcc -Wall -o helloworld helloworld.c
Run with:
./helloworld
```
# C++

```C++
#include <iostream>
int main()
{
std::cout << "Hello, World!" << std::endl;
return 0;
}

g++ -Wall -o helloworld helloworld.cpp
Run with:
./helloworld
```
# Dlang

```D
import std.stdio;
void main()
{
writeln("Hello, World!");
}
Build with:
gdc -Wall -o helloworld helloworld.cpp
Run with:
./helloworld
```
# Go

```Go
package main
import "fmt"
func main() {
fmt.Println("Hello, World!")
}
Build and run with:
go run helloworld.go

# Rust

```Rust
fn main() {
println!("Hello, World");
}
Build with:
rustc hello.rs
Run with:
./helloworld
```
# Java

```Java
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
Build with:
javac HelloWorld.java
Run with:
java HelloWorld
```
# x86_64 Assembly

```x86_64 Assembly
Build with:
TODO
Run with:
TODO
```
# ARM64 Assembly

```
Build with:
TODO
Run with:
./helloworld
```
# Bash

```Bash
echo "Hello, World!"
Run with:

bash helloworld.sh
```

# Python

```Python
print("Hello, World!")
Run with:
python helloworld.py
```
# Ruby

```Ruby
puts "Hello, World!"
Run with:
ruby helloworld.rb
```
# Php

```Php
<?php
echo "Hello, World!"
?>
Run with:
./helloworld

```
# Perl

```Perl
print("Hello, World!\n")
Run with:
perl helloworld.pl
```

# Lua

```Lua
print("Hello, World!")
Run with:
lua helloworld.lua
```