From 38042d1e18bc37dac34c74e094a3678b4c613a7a Mon Sep 17 00:00:00 2001 From: Manish Goregaokar Date: Mon, 27 Apr 2015 14:22:15 +0530 Subject: [PATCH] trpl: clarify lib.rs vs main.rs --- src/doc/trpl/hello-cargo.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/doc/trpl/hello-cargo.md b/src/doc/trpl/hello-cargo.md index 6967532a44735..d547451fccec2 100644 --- a/src/doc/trpl/hello-cargo.md +++ b/src/doc/trpl/hello-cargo.md @@ -32,6 +32,13 @@ $ mkdir src $ mv main.rs src/main.rs ``` +Note that since we're creating an executable, we used `main.rs`. If we +want to make a library instead, we should use `lib.rs`. +Custom file locations for the entry point can be specified +with a [`[[lib]]` or `[[bin]]`][crates-custom] key in the TOML file described below. + +[crates-custom]: http://doc.crates.io/manifest.html#configuring-a-target + Cargo expects your source files to live inside a `src` directory. That leaves the top level for other things, like READMEs, license information, and anything not related to your code. Cargo helps us keep our projects nice and tidy. A