aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 490bd51..ca629b8 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# Fortran Package Manager
This is the repository of the Fortran Package Manager (fpm).
-If you are looking for the Effing Package Management instead, see
+If you are looking for _fpm--packaging made simple_ instead, see
[jordansissel/fpm](https://github.com/jordansissel/fpm).
Fortran Package Manager is an early prototype.
@@ -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: