10000 doc: use proper markdown syntax · weblfe/go-python@0c1d928 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0c1d928

Browse files
committed
doc: use proper markdown syntax
1 parent f4f0f3b commit 0c1d928

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,52 +20,51 @@ Install:
2020
--------
2121

2222
With `Go 1` and the ``go`` tool, ``cgo`` packages can't pass anymore additional ``CGO_CFLAGS`` from external programs (except `pkg-config`) to the "fake" ``#cgo`` preprocessor directive.
23-
So one has to do instead::
23+
So one has to do instead:
2424

25+
```sh
2526
$ mkdir -p $GOPATH/src/github.com/sbinet
2627
$ cd $GOPATH/src/github.com/sbinet
2728
$ git clone http://github.com/sbinet/go-python
2829
$ cd go-python && make
29-
30+
```
3031

3132
Documentation
3233
-------------
3334

34-
Is available on ``gopkgdoc``:
35+
Is available on ``godoc``:
3536

3637
http://godoc.org/github.com/sbinet/go-python
3738

3839

3940
Example:
4041
--------
4142

42-
::
43+
```go
44+
package main
4345

44-
$ cat main.go
45-
package main
46-
47-
import "fmt"
48-
import "github.com/sbinet/go-python"
46+
import "fmt"
47+
import "github.com/sbinet/go-python"
4948

50-
func init() {
51-
err := python.Initialize()
52-
if err != nil {
53-
panic(err.Error())
54-
}
55-
}
49+
func init() {
50+
err := python.Initialize()
51+
if err != nil {
52+
panic(err.Error())
53+
}
54+
}
5655

57-
func main() {
58-
gostr := "foo"
56+
func main() {
57+
gostr := "foo"
5958
pystr := python.PyString_FromString(gostr)
6059
str := python.PyString_AsString(pystr)
6160
fmt.Println("hello [", str, "]")
62-
}
63-
64-
::
65-
66-
$ go run ./main.go
67-
hello [ foo ]
61+
}
62+
```
6863

64+
```sh
65+
$ go run ./main.go
66+
hello [ foo ]
67+
```
6968

7069
TODO:
7170
-----

0 commit comments

Comments
 (0)
0