🎨 nits fixed and add skeleton

xjtu-ics · Jan 25, 2025 · e1f176d · e1f176d
1 parent 63d2bc8
commit e1f176d
Show file tree

Hide file tree

Showing 32 changed files with 184 additions and 36 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -6,23 +6,44 @@
 
 # Course Notes
 
-- [Part 1](./notes/part1/README.md)
-    - [Chapter 1](./notes/part1/ch1.md)
-    - [Chapter 2](./notes/part1/ch2.md)
-- [Part 2](./notes/part2/README.md)
-    - [Chapter 1](./notes/part2/ch1.md)
-    - [Chapter 2](./notes/part2/ch2.md)
+- [Overview](./notes/chapter0/README.md)
+    - [Why ICS](./notes/chapter0/why.md)
+    - [How to Start](./notes/chapter0/start.md)
+    - [Coding is All You Need](./notes/chapter0/coding.md)
+- [Representing and Manipulating Information](./notes/chapter2/README.md)
+    - [Information Storage](./notes/chapter2/sec1.md)
+    - [Integer Representations](./notes/chapter2/sec2.md)
+    - [Integer Arithmetic](./notes/chapter2/sec3.md)
+- [Machine-Level Representation of Programs](./notes/chapter3/README.md)
+    - [A Historical Perspective](./notes/chapter3/sec1.md)
+    - [Program Encodings](./notes/chapter3/sec2.md)
+    - [Data Formats](./notes/chapter3/sec3.md)
+    - [Accessing Information](./notes/chapter3/sec4.md)
+    - [Arithmetic and Logical Operations](./notes/chapter3/sec5.md)
+    - [Control](./notes/chapter3/sec6.md)
+    - [Procedures](./notes/chapter3/sec7.md)
+    - [Array Allocation and Access](./notes/chapter3/sec8.md)
+    - [Heterogeneous Data Structures](./notes/chapter3/sec9.md)
+    - [Combining Control and Data in Machine-Level Programs](./notes/chapter3/sec10.md)
 
 # Labs Materials
 
 - [ICS Labs](./labs/README.md)
-    - [Lab 0](./labs/lab0.md)
-    - [Lab 1](./labs/lab1.md)
-    - [Lab 2](./labs/lab2.md)
-    - [Lab 3](./labs/lab3.md)
-    - [Lab 4](./labs/lab4.md)
-    - [Lab 5](./labs/lab5.md)
-    - [Lab 6](./labs/lab6.md)
+    - [Lab 0 Environmental Preparation](./labs/lab0.md)
+    - [Lab 1 Data Lab](./labs/lab1.md)
+    - [Lab 2 Bomb Lab](./labs/lab2.md)
+    - [Lab 3 Attack Lab](./labs/lab3.md)
+    - [Lab 4 Cache Lab](./labs/lab4.md)
+    - [Lab 5 Optimization Lab](./labs/lab5.md)
+    - [Lab 6 Linker Lab](./labs/lab6.md)
+- [Develop Ops](./dev/README.md)
+    - [How to Use VSCode](./dev/vscode.md)
+    - [Windows? Linux!](./dev/linux.md)
+    - [VSCode? Vim!](./dev/vim.md)
+    - [G__hub? Github!](./dev/github.md)
+    - [SSH: She’s Settled for Him](./dev/ssh.md)
+    - [Git: Girlfriend Is Tricky](./dev/git.md)
+    - [Google Style Guide](./dev/style.md)
 
 ------
 

diff --git a/src/notes/part2/README.md → src/dev/README.md b/src/notes/part2/README.md → src/dev/README.md
@@ -1,4 +1,4 @@
-# Part 1
+# Developer Ops
 
 
 ------

diff --git a/src/dev/git.md b/src/dev/git.md
@@ -0,0 +1,6 @@
+# Git: Girlfriend Is Tricky
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/dev/github.md b/src/dev/github.md
@@ -0,0 +1,6 @@
+# G__hub? Github!
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/dev/linux.md b/src/dev/linux.md
@@ -0,0 +1,6 @@
+# Windows? Linux!
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/dev/ssh.md b/src/dev/ssh.md
@@ -0,0 +1,6 @@
+# SSH: She’s Settled for Him
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/dev/style.md b/src/dev/style.md
@@ -0,0 +1,6 @@
+# Git: Girlfriend Is Tricky
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/part1/ch1.md → src/dev/vim.md b/src/notes/part1/ch1.md → src/dev/vim.md
@@ -1,4 +1,4 @@
-# Chapter 1
+# VSCode? Vim!
 
 
 ------

diff --git a/src/dev/vscode.md b/src/dev/vscode.md
@@ -0,0 +1,6 @@
+# How to Use VSCode
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/misc/contributors.md b/src/misc/contributors.md
@@ -8,11 +8,11 @@ Special thanks to __XJTU-ICS Team Members__. Big shout-out to them 🚀:
 
 - [Danfeng Shan](https://dfshan.github.io/) (Professor)
 - [Hao Li](https://aquatoney.github.io/) (Professor)
-- [Yunguang Li](https://github.com/Hijack8) (HEAD TA, Master Student)
-- [Orion](https://orion-zhen.github.io/) (TA, Senior Student)
-- [Tang Tang](https://github.com/Tangtang1031) (TA, Senior Student)
-- [Jinnuo Du]() (TA, Senior Student)
-- [Boxuan Hu](https://bxhu2004.com/) (TA, Junior Student)
+- [Yunguang Li](https://github.com/Hijack8) (HEAD TA, Master)
+- [Orion](https://orion-zhen.github.io/) (TA, Senior)
+- [Tang Tang](https://github.com/Tangtang1031) (TA, Senior)
+- [Jinnuo Du]() (TA, Senior)
+- [Boxuan Hu](https://bxhu2004.com/) (TA, Junior)
 
 You can view the full list of contributors and their contributions [here](https://github.com/xjtu-ics/textbook/graphs/contributors).
 

diff --git a/src/misc/introduction.md b/src/misc/introduction.md
@@ -1,6 +1,6 @@
 # Introduction to Computer System
 
-> By [ICS Team](./contributors.md), based on lectures by [Danfeng Shan](https://dfshan.github.io/), [Hao Li](https://aquatoney.github.io/), and others.
+> By [ICS Team](https://xjtu-ics.github.io/textbook/misc/contributors.html), based on lectures by [Danfeng Shan](https://dfshan.github.io/), [Hao Li](https://aquatoney.github.io/), and others.
 
 These are the course notes for [COMPSCI 400727: Introduction to Computer System](https://ics.dfshan.net) at Xi'an Jiaotong University.
 
@@ -40,10 +40,11 @@ This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 Inter
 
 The design of this textbook is inspired by many outstanding courses. We would like to express our gratitude to the following courses that have provided us with valuable inspiration:
 
+- [CSAPP @CMU](https://www.cs.cmu.edu/~213/)
 - [CS168 @UC Berkeley](https://textbook.cs168.io/)
 - [CS161 @UC Berkeley](https://fa24.cs161.org/)
-- [CSAPP @CMU](https://www.cs.cmu.edu/~213/)
 - [Operating System @PKU](https://pku-os.github.io/)
+- [Operating System @IPADS-SJTU](https://github.com/SJTU-IPADS/OS-Course-Lab)
 - [ICS @NJU](https://nju-projectn.github.io/ics-pa-gitbook/ics2024/)
 
 ------

diff --git a/src/notes/chapter0/README.md b/src/notes/chapter0/README.md
@@ -0,0 +1,6 @@
+# Chapter 0 Overview
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter0/coding.md b/src/notes/chapter0/coding.md
@@ -0,0 +1,6 @@
+# Coding is All You Need
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/part1/ch2.md → src/notes/chapter0/start.md b/src/notes/part1/ch2.md → src/notes/chapter0/start.md
@@ -1,4 +1,4 @@
-# Chapter 2
+# How to Start
 
 
 ------

diff --git a/src/notes/part1/README.md → src/notes/chapter0/why.md b/src/notes/part1/README.md → src/notes/chapter0/why.md
@@ -1,4 +1,4 @@
-# Part 1
+# Why ICS
 
 
 ------

diff --git a/src/notes/chapter2/README.md b/src/notes/chapter2/README.md
@@ -0,0 +1,6 @@
+# Chapter 2 Representing and Manipulating Information
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter2/sec1.md b/src/notes/chapter2/sec1.md
@@ -0,0 +1,6 @@
+# Chapter 2.1 Information Storage
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter2/sec2.md b/src/notes/chapter2/sec2.md
@@ -0,0 +1,6 @@
+# Chapter 2.2 Integer Representations
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter2/sec3.md b/src/notes/chapter2/sec3.md
@@ -0,0 +1,6 @@
+# Chapter 2.3 Integer Arithmetic
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/README.md b/src/notes/chapter3/README.md
@@ -0,0 +1,6 @@
+# Chapter 3 Machine-Level Representation of Programs
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec1.md b/src/notes/chapter3/sec1.md
@@ -0,0 +1,6 @@
+# Chapter 3.1 A Historical Perspective
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec10.md b/src/notes/chapter3/sec10.md
@@ -0,0 +1,6 @@
+# Chapter 3.10 Combining Control and Data in Machine-Level Programs
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec2.md b/src/notes/chapter3/sec2.md
@@ -0,0 +1,6 @@
+# Chapter 3.2 Program Encodings
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec3.md b/src/notes/chapter3/sec3.md
@@ -0,0 +1,6 @@
+# Chapter 3.3 Data Formats
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec4.md b/src/notes/chapter3/sec4.md
@@ -0,0 +1,6 @@
+# Chapter 3.4 Accessing Information
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec5.md b/src/notes/chapter3/sec5.md
@@ -0,0 +1,6 @@
+# Chapter 3.5 Arithmetic and Logical Operations
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec6.md b/src/notes/chapter3/sec6.md
@@ -0,0 +1,6 @@
+# Chapter 3.6 Control
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec7.md b/src/notes/chapter3/sec7.md
@@ -0,0 +1,6 @@
+# Chapter 3.7 Procedures
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec8.md b/src/notes/chapter3/sec8.md
@@ -0,0 +1,6 @@
+# Chapter 3.8 Array Allocation and Access
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/chapter3/sec9.md b/src/notes/chapter3/sec9.md
@@ -0,0 +1,6 @@
+# Chapter 3.9 Heterogeneous Data Structures
+
+
+------
+
+© 2025. ICS Team. All rights reserved.
diff --git a/src/notes/part2/ch1.md b/src/notes/part2/ch1.md
diff --git a/src/notes/part2/ch2.md b/src/notes/part2/ch2.md