init commit

Author: cch123

LICENSE

@@ -0,0 +1,6 @@
+.PHONY: toc
+
+toc:
+	docker run --rm -it -v ${PWD}:/usr/src jorgeandrada/doctoc --github
+	$(shell tail -n +`grep -n '# \`go-internals\`' README.md | tr ':' ' ' | awk '{print $$1}'` README.md > /tmp/README2.md)
+	cp /tmp/README2.md README.md

Makefile

@@ -0,0 +1,39 @@
+# `go-internals`
+
+`go-internals` is a work-in-progress book about the internals of the Go (1.10+) programming language.
+
+---
+
+## Table of Contents
+
+- [Chapter I: A Primer on Go Assembly](./chapter1_assembly_primer/README.md)
+- [Chapter II: Interfaces](./chapter2_interfaces/README.md)
+- [Chapter III (soon!): The Garbage Collector](./chapter3_garbage_collector/README.md)
+
+---
+
+## Goals
+
+- **Concise**: The book aims to be as concise as possible, encouraging code and diagrams over lengthy prose.
+- **Community-effort**: I myself am learning as I go through the writing of this book. I *will* make mistakes along the way. Hopefully the community can help in pointing out and correcting these mistakes.
+- **Beyond the theory**: The book will not just cover the theory, but the actual implementation too. Assumptions will be proven or invalidated via experiments and measurements.
+- **Up-to-Date**: The book will try to keep up-to-date with new Go versions being released.
+- **Experienced audience**: The Go community has created *loads* of great introductory material for newcomers. Unfortunately we're still lacking good resources when it comes to the more advanced stuff. This books hopes to help solve this issue.
+
+## Contributing
+
+All kinds of contributions are very much welcome.
+
+Don't hesitate to open an issue for e.g...:
+- pointing out technical or english mistakes
+- suggesting improvements and/or additions to existing chapters
+- suggesting external links that might be of interest
+- ..and pretty much anything else you can think of, really!
+
+## Author
+
+Clement Rey <<cr.rey.clement@gmail.com>> ([@teh_cmc](https://twitter.com/teh_cmc))
+
+## License
+
+Licensed under the [BY-NC-SA Creative Commons 4.0 International Public License](http://creativecommons.org/licenses/by-nc-sa/4.0/)

README.md

@@ -0,0 +1,20 @@
+GOOS=linux
+GOARCH=amd64
+
+SOURCES := $(wildcard *.go)
+OBJECTS = $(SOURCES:.go=.o)
+EXECUTABLES = $(OBJECTS:.o=.bin)
+
+.SECONDARY: ${OBJECTS}
+
+all: ${EXECUTABLES}
+
+%.o: %.go
+	GOOS=${GOOS} GOARCH=${GOARCH} go tool compile $<
+
+%.bin: %.o
+	GOOS=${GOOS} GOARCH=${GOARCH} go tool link -o $@ $<
+
+clean:
+	rm -f ${OBJECTS}
+	rm -f ${EXECUTABLES}

chapter1_assembly_primer/Makefile

@@ -0,0 +1,6 @@
+package main
+
+//go:noinline
+func add(a, b int32) (int32, bool) { return a + b, true }
+
+func main() { add(10, 32) }

chapter1_assembly_primer/README.md

@@ -0,0 +1,20 @@
+GOOS=linux
+GOARCH=amd64
+
+SOURCES := $(wildcard *.go)
+OBJECTS = $(SOURCES:.go=.o)
+EXECUTABLES = $(OBJECTS:.o=.bin)
+
+.SECONDARY: ${OBJECTS}
+
+all: ${EXECUTABLES}
+
+%.o: %.go
+	GOOS=${GOOS} GOARCH=${GOARCH} go tool compile $<
+
+%.bin: %.o
+	GOOS=${GOOS} GOARCH=${GOARCH} go tool link -o $@ $<
+
+clean:
+	rm -f ${OBJECTS}
+	rm -f ${EXECUTABLES}