1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.. highlight:: none


.. index::
   pair: developer; guide

.. _design-guide.developer:


New developer guide
===================

.. mps:prefix:: guide.developer


Introduction
------------

:mps:tag:`intro` This is an introduction to the Memory Pool System (MPS) for
new developers.

:mps:tag:`source` This is based on [APT_2018-09-17]_.


What to read first
------------------

* `manual/build.txt`_ -- how to build the MPS.
* `manual/guide`_ -- tutorial for the public interface.
* `manual/topic`_ -- reference manual for the public interface.
* `manual/code-index`_ -- description and purpose of each file of source code.
* design.mps.config_ -- build configuration.
* design.mps.tests_ -- how to run test cases.
* design.mps.doc_ -- how to write and edit documentation.

.. _manual/build.txt: https://www.ravenbrook.com/project/mps/master/manual/build.txt
.. _manual/guide: https://www.ravenbrook.com/project/mps/master/manual/html/guide/index.html
.. _manual/topic: https://www.ravenbrook.com/project/mps/master/manual/html/topic/index.html
.. _manual/code-index: https://www.ravenbrook.com/project/mps/master/manual/html/code-index.html
.. _design.mps.config: config.html
.. _design.mps.tests: tests.html
.. _design.mps.doc: doc.html


References
----------

.. [APT_2018-09-17]
   "Procedure for new developers";
   Alistair Turnbull; Ravenbrook Limited; 2018-09-17;
   <https://info.ravenbrook.com/mail/2018/09/17/11-16-41/0/>