Skip to content

Commit f9554a9

Browse files
[commands] conan new default template (#4356)
* Added conan new default info * wip
1 parent e63a332 commit f9554a9

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

reference/commands/new.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ Note that each template has some required and some [optional] user-defined varia
2020

2121
The available templates are:
2222

23+
- *default* (no argument is required):
24+
Creates a simple and empty CMake consumer recipe. The use case would be an user having
25+
a local CMakeLists.txt and the sources, and want to build them likely using requirements
26+
through Conan:
27+
28+
Its variables are: name, version, [requires1, requires2, ...], [tool_requires1, tool_requires2, ...]
29+
2330
- **basic**:
2431
Creates a simple recipe with some example code and helpful comments,
2532
and is a good starting point to avoid writing boilerplate code.
@@ -130,6 +137,18 @@ By default, all ``name`` and ``version`` variables are set to ``mypkg`` and ``0.
130137
Examples
131138
--------
132139

140+
.. code-block:: text
141+
142+
$ conan new
143+
144+
Generates a simple CMake consumer *conanfile.py*. Notice that neither the CMakeLists.txt nor the sources are created.
145+
146+
.. note::
147+
148+
You could be interested in the :ref:`conan require<reference_commands_require>` command to add some
149+
remote/local requirements to your recipe.
150+
151+
133152
.. code-block:: text
134153
135154
$ conan new basic

0 commit comments

Comments
 (0)