Skip to content

Commit aae7e56

Browse files
authored
Clean up the main README (#868)
1 parent a24a3f8 commit aae7e56

1 file changed

Lines changed: 28 additions & 61 deletions

File tree

README.md

Lines changed: 28 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,27 @@
1-
linux-insides
2-
===============
1+
# Linux insides
32

4-
A book-in-progress about the linux kernel and its insides.
3+
This repository contains a book-in-progress about the Linux kernel and its insides.
54

6-
> [!IMPORTANT]
7-
> I started writing this series when the latest version of the kernel was `3.18`. A lot has changed since then, and I am in the process of updating the content to reflect modern kernels where possible — now focusing on v6.16+. I’ll continue revising the posts as the kernel evolves.
8-
9-
**The goal is simple** - to share my modest knowledge about the insides of the linux kernel and help people who are interested in linux kernel insides, and other low-level subject matter. Feel free to go through the book [Start here](https://github.com/0xAX/linux-insides/blob/master/SUMMARY.md)
10-
11-
**Questions/Suggestions**: Feel free about any questions or suggestions by pinging me at twitter [@0xAX](https://twitter.com/0xAX), adding an [issue](https://github.com/0xAX/linux-insides/issues/new) or just drop me an [email](mailto:anotherworldofworld@gmail.com).
12-
13-
Generating eBooks and PDFs - [documentation](https://github.com/GitbookIO/gitbook/blob/master/docs/ebook.md)
14-
15-
# Mailing List
16-
17-
We have a Google Group mailing list for learning the kernel source code. Here are some instructions about how to use it.
18-
19-
#### Join
5+
The goal of this project is simple – to share knowledge about the Linux kernel internals and related low-level topics. If you’re curious about what’s under the hood, see the [Table of Contents](https://github.com/0xAX/linux-insides/blob/master/SUMMARY.md).
206

21-
Send an email with any subject/content to `kernelhacking+subscribe@googlegroups.com`. Then you will receive a confirmation email. Reply it with any content and then you are done.
7+
> [!IMPORTANT]
8+
> I started writing this series when the latest version of the kernel was `3.18`. A lot has changed since then, and I am in progress of updating the content to reflect modern kernels (v6.16+). I’ll continue revising the posts as the kernel evolves.
229
23-
> If you have Google account, you can also open the [archive page](https://groups.google.com/forum/#!forum/kernelhacking) and click **Apply to join group**. You will be approved automatically.
10+
## Requirements
2411

25-
#### Send emails to mailing list
12+
- Prior knowledge about the [Assembly language](https://en.wikipedia.org/wiki/Assembly_language)
13+
- Proficiency with the [C programming language](https://en.wikipedia.org/wiki/C_(programming_language))
14+
- Additionally, you can find lots of useful information about x86_64 processors in [Intel Software Developer Manuals](https://www.intel.com/content/www/us/en/developer/articles/technical/intel-sdm.html)
2615

27-
Just send emails to `kernelhacking@googlegroups.com`. The basic usage is the same as other mailing lists powered by mailman.
16+
> [!TIP]
17+
> You can get started with Assembler with my other series of posts about the [Assembly programming](https://github.com/0xAX/asm).
2818
29-
#### Archives
19+
## Translations
3020

31-
https://groups.google.com/forum/#!forum/kernelhacking
21+
Thanks to the volunteers, the posts about Linux are translated into different languages.
3222

33-
On other languages
34-
-------------------
23+
> [!NOTE]
24+
> The translations may diverge from the original content.
3525
3626
* [Brazilian Portuguese](https://github.com/mauri870/linux-insides)
3727
* [Chinese](https://github.com/MintCN/linux-insides-zh)
@@ -41,50 +31,27 @@ On other languages
4131
* [Spanish](https://github.com/leolas95/linux-insides)
4232
* [Turkish](https://github.com/ayyucedemirbas/linux-insides_Turkish)
4333

44-
Docker
45-
------
46-
47-
In order to run your own copy of the book with gitbook within a local container:
48-
49-
1. Enable Docker experimental features with vim or another text editor
50-
```bash
51-
sudo vim /usr/lib/systemd/system/docker.service
52-
```
53-
54-
Then add --experimental=true to the end of the ExecStart=/usr/bin/dockerd -H fd:// line and save.
55-
56-
Eg: *ExecStart=/usr/bin/dockerd -H fd:// --experimental=true*
57-
58-
Then, you need to reload and restart the Docker daemon:
59-
```bash
60-
systemctl daemon-reload
61-
systemctl restart docker.service
62-
```
34+
## Contribution
6335

64-
2. Run docker image
65-
```bash
66-
make run
67-
```
36+
Read the [Contribution guide](./CONTRIBUTING.md) to learn how to contribute to the project. When contributing, make sure to follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
6837

69-
3. Open your local copy of linux insides book under this url
70-
http://localhost:4000 or run `make browse`
38+
If you have any questions or suggestions, feel free to ping me at Twitter [@0xAX](https://twitter.com/0xAX), add an [issue](https://github.com/0xAX/linux-insides/issues/new), or drop me an [email](mailto:anotherworldofworld@gmail.com).
7139

40+
## Mailing list
7241

73-
Contributions
74-
--------------
42+
There is a Google group mailing list (`kernelhacking@googlegroups.com`) for learning the kernel source code.
7543

76-
Feel free to create issues or pull-requests if you have any problems.
44+
To join the group, send an email to `kernelhacking+subscribe@googlegroups.com`. You will receive a confirmation email. After replying to it, you will be added to the mailing list.
7745

78-
**Please read [CONTRIBUTING.md](https://github.com/0xAX/linux-insides/blob/master/CONTRIBUTING.md) before pushing any changes.**
46+
> [!TIP]
47+
> If you have a Google account, you can simply open the [archive page](https://groups.google.com/forum/#!forum/kernelhacking) and click **Apply to join group**. You will be approved automatically.
7948
80-
![linux-kernel](Assets/linux-kernel.png)
49+
## License
8150

82-
Author
83-
---------------
51+
This project is licensed under the [BY-NC-SA Creative Commons](http://creativecommons.org/licenses/by-nc-sa/4.0/).
8452

85-
[@0xAX](https://twitter.com/0xAX)
53+
## Author
8654

87-
LICENSE
88-
-------------
55+
The technical content is written by [@0xAX](https://x.com/0xAX).
8956

90-
Licensed [BY-NC-SA Creative Commons](http://creativecommons.org/licenses/by-nc-sa/4.0/).
57+
Additional big thanks to [@klaudiagrz](https://github.com/klaudiagrz) for text improvements.

0 commit comments

Comments
 (0)