From 24e1b98ff84d09f095f48c168e9af05aa00c95ea Mon Sep 17 00:00:00 2001 From: Milan Curcic Date: Sun, 26 Apr 2020 14:40:22 -0400 Subject: update instructions to install stack; add basic instructions for using fpm --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b767268..486e861 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 repo + +``` +git clone https://github.com/fortran-lang/fpm +cd fpm +``` + ### Build and Test FPM -Build using: +Build FPM using: ``` stack build ``` @@ -27,3 +34,18 @@ To test: ``` stack test ``` +To install: +``` +stack install +``` + +### 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`. -- cgit v1.2.3 From 7ace0078320ca4909c672236438821ca46e025f9 Mon Sep 17 00:00:00 2001 From: Milan Curcic Date: Tue, 28 Apr 2020 18:04:16 -0400 Subject: fix repository wording MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Ondřej Čertík --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 486e861..4af8b97 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ and put the `stack` binary in your path, for example: export PATH="$PATH:`pwd`/stack-2.1.3-linux-x86_64-static/" ``` -### Download this repo +### Download this repository ``` git clone https://github.com/fortran-lang/fpm -- cgit v1.2.3 From 37dc3419eb96f1d8a04e067998c1e759ea139e92 Mon Sep 17 00:00:00 2001 From: milancurcic Date: Tue, 28 Apr 2020 18:05:54 -0400 Subject: add stack install destination --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4af8b97..8478599 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ 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 -- cgit v1.2.3