Detail: [#813] Improved documentation

[#813] Improved documentation

Date:
2010-11-23 14:30 Priority:
3

State:
Open

Submitted by:
A. G. (heydji) Assigned to:
Sylvain Le Gall (gildor-admin)

Due in version:
None Product:
None

Operating System:
Windows XP Component:
None

Version:
v0.2.0 Severity:
None

Resolution:
None

URL:

Summary:
Improved documentation

Detailed description
When you start with oasis.exe quickstart, it is written on the web site to use the command oasis.exe -quickstart, but instead you have to type oasis.exe quickstart (no dash). Then a list of modules is asked, but the format is not given. It would be better to have something like: Give the list of ocaml Modules separated with comas. (so that we know what character to use to separate modules). Also a reminder that ocaml Modules should start with a capital letter wouldn't hurt (:-) Since there are internal and external modules, it is nice to alert the user that a list of internal modules will be asked later, and that for the time being only public modules are needed. Finally, (but I haven't checked it in the documentation yet), the tool assumes that ocaml is installed in a directory without any white space in the path. (especially for windows users, do not install ocaml in C:\Program Files). Maybe I should open another bug for this ?

No Followups Have Been Posted

Field	Old Value	Date	By
assigned_to	none	2010-12-01 12:45	gildor-admin