Skip to content

Commit

Permalink
Added godoc badge and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
skx committed Jun 15, 2020
1 parent ad3b5d2 commit eb2bb10
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/skx/bfcc)
[![Go Report Card](https://goreportcard.com/badge/github.com/skx/bfcc)](https://goreportcard.com/report/github.com/skx/bfcc)
[![license](https://img.shields.io/github/license/skx/bfcc.svg)](https://github.com/skx/bfcc/blob/master/LICENSE)
[![Release](https://img.shields.io/github/release/skx/bfcc.svg)](https://github.com/skx/bfcc/releases/latest)
Expand Down
13 changes: 12 additions & 1 deletion main.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
// bfcc is a trivial compiler for converting BrainFuck programs into
// executables.
//
// Trivial "compiler" for BrainFuck
// The bfcc compiler contains a pair of backends which can be used to generate
// executables.
//
// There is a backend named `asm` which converts the input program into an
// assembly-language file, and then compiles it via `gcc`.
//
// Then there is a second backend named `c` which converts the input-program
// into a C source-file, and then also compiles it via `gcc`.
//
// The end result of either approach should be a working, native, executable
// which can be executed to run the brainfuck program.
package main

import (
Expand Down

0 comments on commit eb2bb10

Please sign in to comment.