aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBrad Richardson <brichardson@structint.com>2020-06-19 15:35:32 -0700
committerBrad Richardson <brichardson@structint.com>2020-06-19 15:35:42 -0700
commite4fa1691fa162c4f498a94fc1360666f6ef41be0 (patch)
treeda65319313a811b79025d7fbac1f605263405baf /README.md
parent8d3fd33ece5efc285e138d96d17b0aaa294c6444 (diff)
downloadfpm-e4fa1691fa162c4f498a94fc1360666f6ef41be0.tar.gz
fpm-e4fa1691fa162c4f498a94fc1360666f6ef41be0.zip
Add section on `fpm new` to the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 31759b3..622ab7e 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,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: