Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BeatHubmann authored Jan 9, 2024
1 parent 5fb49d8 commit 00e71b2
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,41 @@
[![Dev Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://formingworlds.github.io/Erebus.jl/dev)
[![Test Coverage](https://codecov.io/gh/formingworlds/Erebus.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/formingworlds/Erebus.jl)
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)

## Table of Contents
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Introduction
`Erebus.jl` is a Julia package developed for computational hydrology simulations in planetesimals. The package is designed to model fluid flow in planetesimals, accounting for various factors such as planetesimal composition, mineralogical and hydrodynamic properties, temperature curves, reaction equations, and other relevant parameters[1].

## Installation
To install `Erebus.jl`, you need to have Julia installed on your system. You can add the package using Julia's package manager. Here's how to do it:

```julia
using Pkg
Pkg.add("Erebus")
```

## Usage
After installation, you can import and use the package in your Julia scripts as follows:

```julia
using Erebus

# Your code here
```

Please refer to the documentation for detailed information on the functions and features provided by `Erebus.jl`.

## Contributing
Contributions to `Erebus.jl` are welcome. If you find a bug or have an idea for an improvement or new feature, please open an issue to discuss it. If you'd like to contribute code, please fork the repository, make your changes, and submit a pull request.

## License
`Erebus.jl` is licensed under the Apache 2.0 license. Please see the `LICENSE` file for more details.

Citations:
[1] https://github.com/

0 comments on commit 00e71b2

Please sign in to comment.