Skip to content

Commit 01d1dc1

Browse files
committed
docs: constistent docs across repos.
1 parent 8fb04a8 commit 01d1dc1

2 files changed

Lines changed: 17 additions & 9 deletions

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,6 @@
2020
# Go workspace file
2121
go.work
2222

23-
.DS_Store
23+
.DS_Store
24+
25+
tools/

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
![build status](https://github.com/praisetompane-programming-languages/go/actions/workflows/go.yaml/badge.svg) <br>
44

5-
**objective**: An in-depth study of:
6-
- Go's Compiler.
7-
- Go's language design, implementation and ecosystem.
5+
## Objectives
6+
- An in-depth study of:
7+
- Go's Compiler.
8+
- Go's language design, implementation and ecosystem.
89

9-
## Language Details:
10+
## Language Details
1011
- [language reference](https://go.dev/ref/spec)
1112
- [compiler](https://github.com/golang/go)
1213
- [base modules index]()
@@ -21,15 +22,20 @@
2122
- [developer contribution guide](https://go.dev/doc/contribute)
2223
- [history](https://go.dev/doc/devel/release)
2324

24-
## Testing:
25+
## Testing
2526

26-
## Use Cases:
27+
## Use Cases
2728
- [Applications for Language]()
2829

29-
## Learning Resources:
30+
## Learning Resources
3031
- [roadmap](https://roadmap.sh/golang)
3132
- practice problems:
3233

33-
## References:
34+
## References
35+
36+
## Legend
37+
**Q**: Question for later research
38+
39+
**MYINC**: My Insight/Conjecture [Could Be Unoriginal/False and Likely Is]
3440

3541
**Disclaimer**: This is an ongoing and incomplete project to unpack these concepts and serve as my distributed memory.

0 commit comments

Comments
 (0)