Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re worked README #315

Merged
merged 3 commits into from
Jun 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,29 @@

![](https://github.com/Metomi/fab/workflows/Build/badge.svg)

The "Fab" build system aims to provide a quick and easy build process tailored towards a
specific subset of scientific software developers. Quick should be in both use and
operation. Easy should mean the simple things are simple and the complicated things
possible.
The "Fab" project aims to provide the means to quickly and easily compile
software in a way tailored for scientific software development. It aims to be
quick both in terms of use and operation. Meanwhile ease should mean the
simple things are simple and the complicated things are possible.

The tool is not intended for general use outside its intended domain although you are,
of course, welcome to use it there. Just don't expect high priority to be given to
features which do not target scientific software development.
Fab is not intended to replace existing tools for compiling general
application software. It targets different problems to, for instance, CMake
derived build systems. This means that if your usage falls outside the focus
of development you shouldn't expect high priority on your feature requests.

## Licence

The software is made available under a 3-clause BSD licence.

## Installation

You may simply use `pip install sci-fab`.
The tool is easily installed using `pip install sci-fab`.

## Usage

Although Fab is in its initial development phases right now and much of the
functionality is yet to be added, the command line interface to the tool is
in place and can be run using the command `fab`
Fab offers two modes of operation. In "zero configuration" mode it is used
directly as a tool by running `fab`. This examines the currently selected
directory and tries to build whatever it finds there.

In "framework" mode it offers a library of building-blocks which a developer
can use to create a build system customised to the needs of their software.