Skip to content

Commit ad6c9ed

Browse files
committed
And have the .md files refer people to the Simulator paper for an overview of
core VM development.
1 parent 27d6243 commit ad6c9ed

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ the VM itself, please use their forums:
99
* http://squeak.org/community/
1010
* http://newspeaklanguage.org
1111

12+
Second, the core VM, which is the execution engine and garbage collector, the
13+
core plugins, are developed in Smalltalk, using the VM Simulator. This
14+
repository contains the code generated by the Simulator, and platform support
15+
code for the entire VM, its CI infrastructure and so on. The core VM **should
16+
not** be developed by editing the generated code. The core VM should be
17+
developed using Smalltalk. You can read about the Simulator here:
18+
* https://www.researchgate.net/publication/328509577_Two_Decades_of_Smalltalk_VM_Development_Live_VM_Development_through_Simulation_Tools
19+
* https://hal.archives-ouvertes.fr/hal-01883380/document
20+
1221
The development of the Cog virtual machine takes place on the *Cog*
1322
branch. External contributors have to submit pull requests for review. Core
1423
contributors will generally work on the Cog branch by pushing to it

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,15 @@ the VM itself, please use their forums:
5858
* http://squeak.org/community/
5959
* http://newspeaklanguage.org
6060

61+
Second, the core VM, which is the execution engine and garbage collector, the
62+
core plugins, are developed in Smalltalk, using the VM Simulator. This
63+
repository contains the code generated by the Simulator, and platform support
64+
code for the entire VM, its CI infrastructure and so on. The core VM **should
65+
not** be developed by editing the generated code. The core VM should be
66+
developed using Smalltalk. You can read about the Simulator here:
67+
* https://www.researchgate.net/publication/328509577_Two_Decades_of_Smalltalk_VM_Development_Live_VM_Development_through_Simulation_Tools
68+
* https://hal.archives-ouvertes.fr/hal-01883380/document
69+
6170
Cog is an evolution of the Squeak Back-to-the-future Smalltalk virtual machine
6271
that provides a number of different Smalltalk virtual machines. The VMs are
6372
developed in Smalltalk, using all the dynamic and reflective facilities of the

0 commit comments

Comments
 (0)