Skip to content

Commit

Permalink
[docs] pin down a few things and update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
krakrjak committed Mar 30, 2019
1 parent 073bb83 commit 3ac8244
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@ FITS - Flexible Image Transport System

This project focuses on building a Haskell native parser for FITS files. This file format is used widely by Astronomers and those analyzing astronomical data. There is currently a C library called `fitsio` and a Haskell wrapper for the library. However, this library can be cumbersome to use and the Haskell bindings are very thin and close to the metal of the `fitsio` library. This project focuses on providing good Haskell bindings and datatypes by implementing the FITS spec directly in Haskell, without the need for a C library. The reference for this work comes from NASA in the US. Conformance is currently limited to the Version 4.0 specification with no extensions. See [the NASA site](https://fits.gsfc.nasa.gov/fits_standard.html) for more details and to download the spec.

# Documentation Building
# Reading Documentation

To build the docs you need `sphinx`. To install it locally to a single user use `pip` with the `--user` option to install `sphinx` and `sphinx-rtd-theme`. Alternatively, on Ubuntu you can install the `python3-sphinx` and `python3-sphinx-rtd-theme` package.
The [readthedocs](https://fits-parse.readthedocs.org) pages contain documentation for the *examples*.
The [API Haddock](https://krakrjak.github.io/fits-parse/index.html) docs for the *master* branch are
on github.io, release documentation will be on [Hackage](https://hackage.haskell.org/package/fits-parse).

You can build the Haddocks for offline use with `stack build --haddock`.

# RTD Building

To build the [readthedocs](https://fits-parse.readthedocs.org) docs you need `sphinx`. To install it
locally for a single user use `pip` with the `--user` option to install `sphinx` and `sphinx-rtd-theme`.
Alternatively, on Ubuntu you can install the `python3-sphinx` and `python3-sphinx-rtd-theme` package.

# Reading Documentation

There are two sites with pointers on using this code. The [readthedocs](https://fits-parse.readthedocs.org) pages should guide you on installation and usage of the `fits-render` program. The [Haddock](https://krakrjak.github.io/fits-parse/index.html) docs are an API reference, which you can build locally with `stack build --haddock` for offline viewing.
2 changes: 1 addition & 1 deletion package.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: fits-parse
version: 0.0.1
synopsis: Parse FITS files
description: Parse and manipulate FITS data natively in Haskell without the need of fits-io.
description: Parse and manipulate FITS data natively in Haskell
homepage: https://github.com/krakrjak/fits-parse#readme
license: BSD2
author: Zac Slade
Expand Down

0 comments on commit 3ac8244

Please sign in to comment.