aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2019-08-13 14:20:47 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2019-08-13 14:20:47 +0200
commit979108decea73fc2ae194d91207dbc9068572dc2 (patch)
treeb5197690746b837fe20de346386bb4c756f1a2ec
parentad2d505205abda3cb6af04deff279d0466a13c52 (diff)
Update intro with creation of new projects from existing directory
-rw-r--r--doc/intro.cli19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/intro.cli b/doc/intro.cli
index 64f145d..e672f4d 100644
--- a/doc/intro.cli
+++ b/doc/intro.cli
@@ -565,6 +565,25 @@ $ git remote add origin git@github.com:john-doe/hello.git
$ git push -u
\
+We could have also done it the other way around: first created a project on
+one of the hosting services (GitHub, GitLab, etc) cloned it, and then ran
+\c{new} on that. One advantage of this approach is the \c{new} command's
+ability to automatically extract the license and description from the existing
+\c{LICENSE} and \c{README.md} files and use that to generate the \c{manifest}
+file. This way we only need to specify things once and everything is nice and
+consistent. Here is an example of this streamlined project creation workflow
+(notice also the omitted project name in the \c{new} command):
+
+\
+# Create a project with LICENSE and README.md on one of the Git
+# hosting services (GitHub, GitLab, etc) and then:
+
+$ git clone .../hello.git
+$ cd hello
+
+$ bdep new -t exe -l c++
+\
+
While we have managed to test a couple of platforms (Linux and Windows) and
compiler versions (Clang and GCC) locally, there are quite a few combinations
that we haven't tried (Mac OS with Apple Clang and Windows with MSVC, to name