Merge pull request #102 from everythingfunctional/CreateNewCommand

Enable fpm to create a new package

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
index 58a92c1..6aac019 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,19 @@ stack install
 
 On Linux, the above command installs `fpm` to `${HOME}/.local/bin`.
 
+### Creating a new project
+
+Creating a new fpm project is as simple as running the command `fpm new project_name`.
+This will create a new folder in your current directory with the following contents
+and initialized as a git repository.
+
+* `fpm.toml` with your project's name and some default standard meta-data
+* `README.md` with your project's name
+* `.gitgnore`
+* `src/project_name.f90` with a simple hello world subroutine
+* `app/main.f90` (if `--with-executable` flag used) a program that calls the subroutine
+* `test/main.f90` (if `--with-test` flag used) an empty test program
+
 ### Building your Fortran project with fpm
 
 fpm understands the basic commands: