Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gha3mi committed Apr 15, 2024
1 parent 942199c commit ccc0949
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,14 @@ ForCAD supports **B-Spline**, **NURBS**, **Bezier**, and **Rational Bezier** cur
- Includes predefined NURBS shapes: Circle, Tetragon, Hexahedron.
- Rotate and translate NURBS objects.

## fpm dependency
## Installation

If you want to use ForCAD as a dependency in your own fpm project,
you can easily include it by adding the following line to your `fpm.toml` file:
### Reuirements

```toml
[dependencies]
forcad = {git="https://github.com/gha3mi/forcad.git"}
```

## How to run examples
- A Fortran compiler, such as [GNU Fortran](https://gcc.gnu.org/fortran/) (`gfortran`), [Intel Fortran Compiler](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit.html) (`ifx/ifort`) or [NVIDIA HPC SDK Fortran compiler](https://developer.nvidia.com/hpc-sdk) (`nvfortran`).
- The Fortran Package Manager [fpm](https://fpm.fortran-lang.org/).

To get started, follow these steps:

**Clone the repository:**
### Clone the repository

Clone the ForCAD repository from GitHub:

Expand All @@ -46,14 +39,23 @@ git clone https://github.com/gha3mi/forcad.git
cd forcad
```

### Using fpm

### Running Examples with fpm

```shell
fpm run --example <file name excluding the .f90 extension>
```
Once the examples have been executed, `.vtk` files will be generated within the `vtk` directory. These files can then be visualized using tools such as [ParaView](https://www.paraview.org/).

### Using ForCAD as a fpm Dependency

If you want to use ForCAD as a dependency in your own fpm project,
you can easily include it by adding the following line to your `fpm.toml` file:

```toml
[dependencies]
forcad = {git="https://github.com/gha3mi/forcad.git"}
```

## API documentation

The most up-to-date API documentation for the master branch is available
Expand Down

0 comments on commit ccc0949

Please sign in to comment.