Algorithms/go-perfbook
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add ToC to readme

Browse Source
This commit is contained in:
Adam Shannon 2018-02-24 13:13:51 -06:00
parent 423ef443f6
commit 49069df41b
2 changed files with 43 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README
View File

@ -1,11 +0,0 @@
This is a work-in-progress book in Go performance.
There are different ways to contribute:
1) add to or summarizes the resources in TODO
2) add bullet points or new topics to be covered
3) write prose and flesh out the sections in the book
Eventually sample programs to optimize and exercises will be needed (maybe).
Coordination will be done in the #performance channel on the Gophers slack.

43
README.md Normal file
View File

@ -0,0 +1,43 @@
# go-perfbook
This document outlines best practices for writing high-performance Go code.
### Table of Contents
1. [Writing and Optimizing Go code](performance.md#writing-and-optimizing-go-code)
1. [How to Optimize](performance.md#how-to-optimize)
1. [Optimization Workflow](performance.md#optimization-workflow)
1. [Concrete Optimization Tips](performance.md#concrete-optimization-tips)
1. [Optimization Workflow Summary](performance.md#optimization-workflow-summary)
1. [Data Changes](performance.md#data-changes)
1. [Algorithmic Changes](performance.md#algorithmic-changes)
1. [Benchmark Inputs](performance.md#benchmark-inputs)
1. [Program Tuning](performance.md#program-tuning)
1. [Tooling](performance.md#tooling)
1. [Profiling](performance.md#introductory-profiling)
1. [Tracer](performance.md#tracer)
1. [Garbage Collection](performance.md#garbage-collection)
1. [Runtime and Compiler](performance.md#runtime-and-compiler)
1. [Unsafe](performance.md#unsafe)
1. [Common gotchas with the standard library](performance.md#common-gotchas-with-the-standard-library)
1. [Alternate Implementations](performance.md#alternate-implementations)
1. [CGO](performance.md#cgo)
1. [Advanced Techniques](performance.md#advanced-techniques)
1. [Assembly](performance.md#assembly)
1. [Optimizing an Entire Service](performance.md#optimizing-an-entire-service)
1. Appendix
1. [Implementing Research Papers](performance.md#appendix-implementing-research-papers)
### Contributing
This is a work-in-progress book in Go performance.
There are different ways to contribute:
1) add to or summarizes the resources in TODO
2) add bullet points or new topics to be covered
3) write prose and flesh out the sections in the book
Eventually sample programs to optimize and exercises will be needed (maybe).
Coordination will be done in the #performance channel on the Gophers slack.