Skip to content

Commit eb2bb10

Browse files
committed
Added godoc badge and documentation
1 parent ad3b5d2 commit eb2bb10

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/skx/bfcc)
12
[![Go Report Card](https://goreportcard.com/badge/github.com/skx/bfcc)](https://goreportcard.com/report/github.com/skx/bfcc)
23
[![license](https://img.shields.io/github/license/skx/bfcc.svg)](https://github.com/skx/bfcc/blob/master/LICENSE)
34
[![Release](https://img.shields.io/github/release/skx/bfcc.svg)](https://github.com/skx/bfcc/releases/latest)

main.go

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
1+
// bfcc is a trivial compiler for converting BrainFuck programs into
2+
// executables.
13
//
2-
// Trivial "compiler" for BrainFuck
4+
// The bfcc compiler contains a pair of backends which can be used to generate
5+
// executables.
36
//
7+
// There is a backend named `asm` which converts the input program into an
8+
// assembly-language file, and then compiles it via `gcc`.
9+
//
10+
// Then there is a second backend named `c` which converts the input-program
11+
// into a C source-file, and then also compiles it via `gcc`.
12+
//
13+
// The end result of either approach should be a working, native, executable
14+
// which can be executed to run the brainfuck program.
415
package main
516

617
import (

0 commit comments

Comments
 (0)