Skip to content

Commit

Permalink
docs/readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joshday committed Jun 17, 2024
1 parent 6d6cfb1 commit 5852983
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# QGIS

[![Build Status](https://github.com/joshday/QGIS.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/joshday/QGIS.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![CI](https://github.com/JuliaComputing/QGIS.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/JuliaComputing/QGIS.jl/actions/workflows/CI.yml)
[![DOCS](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliacomputing.github.io/QGIS.jl/dev)

# QGIS

This package uses the [command line processing](https://docs.qgis.org/3.34/en/docs/user_manual/processing/standalone.html) utilities of QGIS to run geoprocessing tasks from Julia. QGIS.jl is unaffiliated with the [QGIS](https://github.com/qgis/QGIS) project.
16 changes: 13 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
[![CI](https://github.com/JuliaComputing/QGIS.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/JuliaComputing/QGIS.jl/actions/workflows/CI.yml)
[![DOCS](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliacomputing.github.io/QGIS.jl/dev)

# QGIS.jl

**QGIS.jl** provides a Julia interface to the [QGIS](https://qgis.org) geospatial processing library via QGIS' [command line utilities](https://docs.qgis.org/3.34/en/docs/user_manual/processing/standalone.html).
**QGIS.jl** provides a Julia interface to the [QGIS](https://qgis.org) geospatial processing library via QGIS' [command line utilities](https://docs.qgis.org/3.34/en/docs/user_manual/processing/standalone.html). QGIS.jl is unafliliated with the [QGIS](https://qgis.org/en/site/) project.

!!! note "Julia Geospatial Ecosystem"
Note that since QGIS.jl works directly with file names, you will likely need other packages to read and write geospatial files, such as:
- [GeoJSON.jl](https://github.com/JuliaGeo/GeoJSON.jl)
- [Shapefile.jl](https://github.com/JuliaGeo/Shapefile.jl)
- [ArchGDAL.jl](https://github.com/yeesian/ArchGDAL.jl)
- Other packages within the [JuliaGeo](https://github.com/JuliaGeo) GitHub organization.

## Setup
## Installation

To install QGIS.jl, run:

Expand All @@ -12,7 +22,7 @@ using Pkg
Pkg.add("QGIS")
```

## Getting Started
## Loading QGIS

To load the QGIS package, run

Expand Down

0 comments on commit 5852983

Please sign in to comment.