aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMilan Curcic <caomaco@gmail.com>2020-04-28 18:17:52 -0400
committerGitHub <noreply@github.com>2020-04-28 18:17:52 -0400
commitb238935f5462fe72d06ef1042a74cc2c312cee57 (patch)
treef809c0743fbb5480414a7b2e6f8effd4d5485bf3
parentbf61658e0f3692922bddb8ce0feceff1efff3a22 (diff)
parent37dc3419eb96f1d8a04e067998c1e759ea139e92 (diff)
downloadfpm-b238935f5462fe72d06ef1042a74cc2c312cee57.tar.gz
fpm-b238935f5462fe72d06ef1042a74cc2c312cee57.zip
Merge pull request #58 from milancurcic/update-readme-and-executable-name
Update readme and executable name
-rw-r--r--README.md34
-rw-r--r--package.yaml2
2 files changed, 30 insertions, 6 deletions
diff --git a/README.md b/README.md
index b767268..8478599 100644
--- a/README.md
+++ b/README.md
@@ -2,24 +2,31 @@
A prototype version.
-## How to try it out
+## Getting started
### Install Haskell
-Install Haskell Stack from (https://haskellstack.org/). E.g., to install on
-Linux without root access, follow the [manual download](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2):
+To install [Haskell Stack](https://haskellstack.org/) on
+Linux without root access, follow the [manual download](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2) procedure:
```
wget https://get.haskellstack.org/stable/linux-x86_64-static.tar.gz
tar xaf linux-x86_64-static.tar.gz
```
-and put the `stack` binary in your path, for example by:
+and put the `stack` binary in your path, for example:
```
export PATH="$PATH:`pwd`/stack-2.1.3-linux-x86_64-static/"
```
+### Download this repository
+
+```
+git clone https://github.com/fortran-lang/fpm
+cd fpm
+```
+
### Build and Test FPM
-Build using:
+Build FPM using:
```
stack build
```
@@ -27,3 +34,20 @@ To test:
```
stack test
```
+To install:
+```
+stack install
+```
+
+On Linux, the above command installs `stack` to `${HOME}/.local/bin`.
+
+### Building your Fortran project with FPM
+
+1. Copy `example_fpm.toml` from this repository
+to the base directory of your Fortran project.
+2. Rename it to `fpm.toml`.
+3. Edit `fpm.toml` for your package.
+4. Type `fpm build`.
+5. (optional) If you have tests, type `fpm test`.
+6. (optional) If your package is an executable program,
+run it by typing `fpm run`.
diff --git a/package.yaml b/package.yaml
index c46000a..a326485 100644
--- a/package.yaml
+++ b/package.yaml
@@ -36,7 +36,7 @@ library:
source-dirs: src
executables:
- fpm-exe:
+ fpm:
main: Main.hs
source-dirs: app
ghc-options: