Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-18 21:29:18 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Code formatting for module headers

Browse source
This commit is contained in:
Justin Ethier 2023-03-04 07:43:01 -08:00
parent 1f5aa9a197
commit 09795fbc05
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Architecture.md
View file

@ -18,11 +18,11 @@ For more high-level overview of the project a good place to start is [Writing th
This section provides an overview of the code and module layout used by Cyclone. The [API Documentation](docs/API.md) provides more details on individual modules within these directories as well as code-level API documentation. This section provides an overview of the code and module layout used by Cyclone. The [API Documentation](docs/API.md) provides more details on individual modules within these directories as well as code-level API documentation.
## scheme/ ## `scheme/`
Code for the built-in Scheme standard libraries lives at the top level of this directory. In general all of the code here is written to conform to the Scheme R7RS specification. Code for the built-in Scheme standard libraries lives at the top level of this directory. In general all of the code here is written to conform to the Scheme R7RS specification.
## scheme/cyclone ## `scheme/cyclone`
Scheme code for the Cyclone compiler itself lives here as a set of libraries. Scheme code for the Cyclone compiler itself lives here as a set of libraries.
@ -31,13 +31,13 @@ There are front-end programs at the top-level of the Cyclone repository that use
- `cyclone.scm` for the compiler - `cyclone.scm` for the compiler
- `icyc.scm` for the interpreter - `icyc.scm` for the interpreter
## srfi/ ## `srfi/`
Implementations of various Scheme SRFI's that are distributed directly with Cyclone. Implementations of various Scheme SRFI's that are distributed directly with Cyclone.
In general the recommended way to distribute SRFI's is to use the Winds package manager. At this point there would need to be a very good reason to include a new SRFI here in the main Cyclone repository. In general the recommended way to distribute SRFI's is to use the Winds package manager. At this point there would need to be a very good reason to include a new SRFI here in the main Cyclone repository.
## runtime.c ## `runtime.c`
Most of the code for the C runtime lives here including primitives and the minor GC. Most of the code for the C runtime lives here including primitives and the minor GC.
@ -45,13 +45,13 @@ Code here is often written in a continuation passing style because Cheney on the
TODO: for example TODO: for example
## gc.c ## `gc.c`
Module for the major garbage collector. Module for the major garbage collector.
For comprehensive design documentation on the major collector see the [Garbage Collector](Garbage-Collector-Revised-2022.md) documentation. For comprehensive design documentation on the major collector see the [Garbage Collector](Garbage-Collector-Revised-2022.md) documentation.
## mstreams.c ## `mstreams.c`
Code for in-memory streams. Some of this is platform-specific. Code for in-memory streams. Some of this is platform-specific.