Skip to content

Commit

Permalink
Doc: Deprecate template basic.ppx and use client-server.basic instead
Browse files Browse the repository at this point in the history
  • Loading branch information
balat committed Jan 5, 2024
1 parent 3c956a4 commit fc24060
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
12 changes: 7 additions & 5 deletions doc/10.x/manual/workflow-distillery.wiki
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,18 @@ To see all available templates, you can use
$ eliom-distillery -list-templates
>>

Template "basic" create a very simple project (makefiles and configuration file
and main service).
Template "client-server.basic" create a simple project (Dune-based build system,
configuration file and main service).
Alternatively, you might want to use the legacy "basic.ppx" template,
with a Makefile-based build system.

To create your project, do:

<<code language="shell"|
$ eliom-distillery -name <name> -template basic.ppx [-target-directory <dir>]
$ eliom-distillery -name <name> -template client-server.basic [-target-directory <dir>]
>>

This creates a project named {{{<name>}}} from the {{{"basic.ppx"}}}
This creates a project named {{{<name>}}} from the {{{"client-server.basic"}}}
template in the directory {{{<dir>}}} or {{{<name>}}} by default.
The project name should be a valid name for an OCaml compilation unit.
The project directory contains the following files
Expand Down Expand Up @@ -115,5 +117,5 @@ list all reserved project names in the special file
{{{%%%MODULE_NAME%%%}}}) by the project name (resp. by the project
name with the first letter capitalized).

For examples, see pre-defined templates like {{{basic.ppx}}} and
For examples, see pre-defined templates like {{{client-server.basic}}}, {{{basic.ppx}}} and
{{{os.pgocaml}}}.
12 changes: 7 additions & 5 deletions doc/dev/manual/workflow-distillery.wiki
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,18 @@ To see all available templates, you can use
$ eliom-distillery -list-templates
>>

Template "basic" create a very simple project (makefiles and configuration file
and main service).
Template "client-server.basic" create a simple project (Dune-based build system,
configuration file and main service).
Alternatively, you might want to use the legacy "basic.ppx" template,
with a Makefile-based build system.

To create your project, do:

<<code language="shell"|
$ eliom-distillery -name <name> -template basic.ppx [-target-directory <dir>]
$ eliom-distillery -name <name> -template client-server.basic [-target-directory <dir>]
>>

This creates a project named {{{<name>}}} from the {{{"basic.ppx"}}}
This creates a project named {{{<name>}}} from the {{{"client-server.basic"}}}
template in the directory {{{<dir>}}} or {{{<name>}}} by default.
The project name should be a valid name for an OCaml compilation unit.
The project directory contains the following files
Expand Down Expand Up @@ -115,5 +117,5 @@ list all reserved project names in the special file
{{{%%%MODULE_NAME%%%}}}) by the project name (resp. by the project
name with the first letter capitalized).

For examples, see pre-defined templates like {{{basic.ppx}}} and
For examples, see pre-defined templates like {{{client-server.basic}}}, {{{basic.ppx}}} and
{{{os.pgocaml}}}.

0 comments on commit fc24060

Please sign in to comment.