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

Initial file

Browse source
This commit is contained in:
Justin Ethier 2016-01-12 19:14:43 -05:00
parent 2019b84149
commit 5ecd505ea4
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/User-Manual.md Normal file
View file

@ -0,0 +1,27 @@
Outline of the user manual:
for now, this will all be one page. the API can be linked to
- Introduction
- Requirements
supported platforms, packages required to build, etc
- Installation
installation procedure
- Usage
- Compiling Scheme files / libraries
include requirements on input files, generated files, etc
- Command line options
- especially include debug ones, such as -t (and what about -d?)
- Interpreter
- Language Details
- explain how programs are setup
- outline scheme language based on r7rs, link to it.
explain differences between cyclone implementation and r7rs, or again at least link to them
- provide API, or at least links to the API
- what else?
- Foreign Function Interface
- Debugging
include profiling instructions?
- Limitations???
- References / Further Reading
- Contact
- include information on bug reports (or should that go towards the beginning?)