From 5130eb14f775f79d6652bf471a309f4bf26bc290 Mon Sep 17 00:00:00 2001 From: milancurcic Date: Wed, 17 Mar 2021 10:53:55 -0400 Subject: add Sebastian's Conda instructions --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index be96b4f..e4dca52 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,35 @@ To report a bug report or suggest a feature, please read our ## Getting started -### Binary download +### Setting up fpm + +#### Binary download `x86-64` binaries are available [to download](https://github.com/fortran-lang/fpm/releases) for Windows, MacOS and Linux. __Note:__ On Linux and MacOS, you will need to enable executable permission before you can use the binary. _e.g._ `$ chmod u+x fpm-v0.1.0-linux-x86_64` -__Github actions:__ to setup *fpm* within Github actions for automated testing, you can use the [fortran-lang/setup-fpm](https://github.com/marketplace/actions/setup-fpm) action. +#### Conda + +If you haven't yet, first enable the conda-forge channel: + +``` +conda config --add channels conda-forge +``` + +Fpm can be installed with: + +``` +conda create -n fpm fpm +conda activate fpm +``` + +#### Github Actions + +To setup *fpm* within Github actions for automated testing, you can use the [fortran-lang/setup-fpm](https://github.com/marketplace/actions/setup-fpm) action. + +#### Bootstraping on other platforms For other platforms and architectures have a look at the [bootstrapping instructions](#bootstrapping-instructions). -- cgit v1.2.3 From 333025da9660c7260f74e8f8ffc34f2b2ffb1e75 Mon Sep 17 00:00:00 2001 From: milancurcic Date: Wed, 17 Mar 2021 11:28:32 -0400 Subject: add a note on where to get Conda --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index e4dca52..ffbda20 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,9 @@ conda create -n fpm fpm conda activate fpm ``` +Conda can be installed from [miniconda](https://docs.conda.io/en/latest/miniconda.html) +or from [miniforge](https://github.com/conda-forge/miniforge/releases). + #### Github Actions To setup *fpm* within Github actions for automated testing, you can use the [fortran-lang/setup-fpm](https://github.com/marketplace/actions/setup-fpm) action. -- cgit v1.2.3 From fc9fea90256f9dc9221fbfaed4dc9ecc03832bab Mon Sep 17 00:00:00 2001 From: Sebastian Ehlert <28669218+awvwgk@users.noreply.github.com> Date: Wed, 17 Mar 2021 17:48:42 +0100 Subject: Update conda installation instructions --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ffbda20..4dff513 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ _e.g._ `$ chmod u+x fpm-v0.1.0-linux-x86_64` #### Conda -If you haven't yet, first enable the conda-forge channel: +Fpm is available on conda-forge, to add conda-forge to your channels use: ``` conda config --add channels conda-forge @@ -41,8 +41,8 @@ conda create -n fpm fpm conda activate fpm ``` -Conda can be installed from [miniconda](https://docs.conda.io/en/latest/miniconda.html) -or from [miniforge](https://github.com/conda-forge/miniforge/releases). +The conda package manager can be installed from [miniforge](https://github.com/conda-forge/miniforge/releases) +or from [miniconda](https://docs.conda.io/en/latest/miniconda.html). #### Github Actions @@ -118,4 +118,3 @@ with itself and run the tests with: $ cd fpm $ fpm test ``` - -- cgit v1.2.3 From 70346ebce13ca542216a2669a5d760216c99de0f Mon Sep 17 00:00:00 2001 From: Milan Curcic Date: Sun, 21 Mar 2021 10:01:10 -0400 Subject: Add fpm description and reorganize the README intro (#402) --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4dff513..7b4078f 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,28 @@ # Fortran Package Manager -This is the repository of the Fortran Package Manager (*fpm*). 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. You can use it to build and -package your Fortran projects, as well as to include supported Fortran -dependency projects. As a prototype, changes to *fpm*’s behavior and inputs may -occur as development continues. Please follow the -[issues](https://github.com/fortran-lang/fpm/issues) to contribute and/or stay -up to date with the development. As the prototype matures and we enter -production, we will do our best to stay backwards compatible. - -To report a bug report or suggest a feature, please read our -[contributor guidelines](CONTRIBUTING.md). +Fortran Package Manager (fpm) is a package manager and build system for Fortran. +Its key goal is to improve the user experience of Fortran programmers. +It does so by making it easier to build your Fortran program or library, run the +executables, tests, and examples, and distribute it as a dependency to other +Fortran projects. +Fpm's user interface is modeled after [Rust's Cargo](https://crates.io/), +so if you're familiar with that tool, you will feel at home with fpm. +Fpm's long term vision is to nurture and grow the ecosystem of modern Fortran +applications and libraries. + +Fpm is an early prototype and is evolving rapidly. +You can use it to build and package your Fortran projects, as well as to use +existing fpm packages as dependencies. +Fpm's behavior and user interface may change as it evolves, however as fpm +matures and we enter production, we will aim to stay backwards compatible. +Please follow the [issues](https://github.com/fortran-lang/fpm/issues) to +contribute and/or stay up to date with the development. +Before opening a bug report or a feature suggestion, please read our +[Contributor Guide](CONTRIBUTING.md). + +Fortran Package Manager is not to be confused with +[Jordan Sissel's fpm](https://github.com/jordansissel/fpm), a more general, +non-Fortran related package manager. ## Getting started -- cgit v1.2.3