change root README.md file

README.md

@@ -1,22 +1,31 @@
 # Toolchain Notes
 
-This repository contains the notes I've taken while diving into the source code of [rolldown](https://github.com/rolldown/rolldown) and [oxc](https://github.com/oxc-project/oxc).
+*by Christophe Rosset*
 
-My goal is to keep track of my findings and understandings. By open-sourcing this, it might help others (those repositories can be hard to dive into).
+My original goal was to better understand the internals of the oxc ecosystem, which as of this day may well be on track to be the new standard for JavaScript tooling.
+
+This involves subjects that I really enjoy, some of them I know well, some others I wish to get better at. This repository contains the notes I've taken while diving into the source code of [rolldown](https://github.com/rolldown/rolldown), [oxc](https://github.com/oxc-project/oxc) and its ecosystem.
+
+The goal isn't to explain each line of code (they will eventually evolve over time), but to understand how the blocks fit together and how the technologies are used.
+
+If you read this book, you will:
+
+- Get into the internals of [rolldown](./rolldown/README.md), [oxc](./oxc/README.md) (the oxc part is still wip)
+- Discover how technologies such as Wasm and Napi are used inside those projects
 
 Disclaimer: This work is based on myself reading the source code over multiple repositories.
 
 - I might get some things wrong
-- Some of my findings may end up out of date somehow (I try not to link to too specific implementations that could change over time)
-
-If you like this work, if you feel you can share improvements, you can contribute.
+- Some of my findings may end up out of date somehow
 
 An html version is available at <https://topheman.github.io/toolchain-notes/>
 
 [You can also read the book directly on github](./src/SUMMARY.md).
 
 ## Contributing
 
+I wrote something incorrect ? You can make a contribution and fix it.
+
 Click on the link on top right of the book, this will prompt you to fork the project and you will be able to make the modification directly in the github UI.
 
 You can also propose a PR by hand.

src/README.md

@@ -1,18 +1,35 @@
 # Toolchain Notes
 
-This repository contains the notes I've taken while diving into the source code of [rolldown](https://github.com/rolldown/rolldown) and [oxc](https://github.com/oxc-project/oxc).
+*by Christophe Rosset*
 
-My goal is to keep track of my findings and understandings. By open-sourcing this, it might help others (those repositories can be hard to dive into).
+My original goal was to better understand the internals of the oxc ecosystem, which as of this day may well be on track to be the new standard for JavaScript tooling.
+
+This involves subjects that I really enjoy, some of them I know well, some others I wish to get better at. This repository contains the notes I've taken while diving into the source code of [rolldown](https://github.com/rolldown/rolldown), [oxc](https://github.com/oxc-project/oxc) and its ecosystem.
+
+The goal isn't to explain each line of code (they will eventually evolve over time), but to understand how the blocks fit together and how the technologies are used.
+
+If you read this book, you will:
+
+- Get into the internals of [rolldown](./rolldown/README.md), [oxc](./oxc/README.md) (the oxc part is still wip)
+- Discover how technologies such as Wasm and Napi are used inside those projects
 
 Disclaimer: This work is based on myself reading the source code over multiple repositories.
 
 - I might get some things wrong
-- Some of my findings may end up out of date somehow (I try not to link to too specific implementations that could change over time)
-
-If you like this work, if you feel you can share improvements, you can contribute.
+- Some of my findings may end up out of date somehow
 
 ## Contributing
 
+I wrote something incorrect ? You can make a contribution and fix it.
+
 Click on the link on top right of the book, this will prompt you to fork the project and you will be able to make the modification directly in the github UI.
 
 You can also propose a PR by hand.
+
+## The Author
+
+Christophe Rosset
+
+<p style="text-align:center">
+  <a href="https://github.com/topheman">github</a> - <a href="https://x.com/topheman">twitter</a> - <a href="http://linkedin.com/in/topheman">linkedin</a>
+</p>