Skip to content

Commit 93a6964

Browse files
committed
spruce up readme
1 parent e8b5725 commit 93a6964

File tree

2 files changed

+25
-12
lines changed

2 files changed

+25
-12
lines changed

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,40 @@
1-
# Go, go, go!
1+
![](./readme-assets/giphy.gif)
22

3-
A rapid(ish) introductory course to backend software engineering.
3+
# Let's go!
4+
5+
An immersive, introductory course to backend software engineering using [go](https://go.dev).
46

57
## Requirements
68

7-
- You are familiar with the essentials of writing code in JavaScript
8-
- You have used JavaScript in the browser and in [Node][node]
9-
- You have completed the [Tour of Go][tourofgo]
9+
Before you start this course, there's a few things we assume you've done:
10+
11+
- You're familiar with the essentials of writing code in JavaScript
12+
- You have experience with JavaScript in the browser and in [Node][node]
13+
- You've completed the [Tour of Go][tourofgo]
14+
15+
This is important because we don't cover the basic language features of Go: you need to be familiar with writing Go functions and methods, plus the basics of types in Go. You'll also need to to navigate [packages and documentation](https://pkg.go.dev/).
1016

11-
Remember you can _always_ Google or ask for help if you get stuck.
17+
Remember: you can _always_ Google or ask for help if you get stuck.
1218

1319
## Projects
1420

15-
Each project has its own directory and a reference implementation on a branch, with an associated [Pull Request](https://github.com/CodeYourFuture/immersive-go-course/pulls).
21+
This course is structured into self-contained projects that you can work through at your own pace.
1622

17-
- [CLI & Files](./cli-files)`impl/cat-ls`
18-
- [Servers & HTTP requests](./http-auth) - `impl/http-auth`
19-
- [Servers & Databases](./server-database) - `impl/server-database`
23+
Each project has its own directory with a README.md file that has instructions. If you want to take a look at one way of completing an exercise, there's some code waiting in an associated [Pull Request](https://github.com/CodeYourFuture/immersive-go-course/pulls) for you to look at. Try not to copy!
24+
25+
1. [CLI & Files](./cli-files)`impl/cat-ls`
26+
<br>An introduction to building things with Go by replicating the unix tools `cat` and `ls`.
27+
1. [Servers & HTTP requests](./http-auth) - `impl/http-auth`
28+
<br>Learn about long-running processes, HTTP and `curl`.
29+
1. [Servers & Databases](./server-database) - `impl/server-database`
30+
<br>Build a server that takes data from a database and serves it in `json` format.
2031

2132
## Authors
2233

23-
Tom Ashworth
24-
Daniel Wagner-Hall
34+
- Tom Ashworth
35+
- Daniel Wagner-Hall
36+
37+
Feel free to ask for help in the CYF Slack!
2538

2639
[tourofgo]: https://go.dev/tour
2740
[node]: https://nodejs.org/en/

readme-assets/giphy.gif

55 KB
Loading

0 commit comments

Comments
 (0)