diff options
| -rw-r--r-- | LICENSE | 21 | ||||
| -rw-r--r-- | README.md | 34 | ||||
| -rw-r--r-- | package.yaml | 2 |
3 files changed, 51 insertions, 6 deletions
@@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 fpm contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. @@ -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: |