diff --git a/README.md b/README.md index dfdd5121..9c537b13 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ + # geocompy [![Render](https://github.com/geocompx/geocompy/actions/workflows/main.yaml/badge.svg)](https://github.com/geocompx/geocompy/actions/workflows/main.yaml) @@ -6,9 +7,14 @@ [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=447558863) - +Geocomputation with Python is an open source book project that will be +published as a physical book. We are developing it in the open and +publishing an up-to-date online version at . + +## Dependencies -Running the code in this book requires the following: +Running the code that is part of Geocomputation with Python (geocompy +for short) requires the following dependencies to be installed: 1. Python dependencies, which can be installed with [`pip`](https://pypi.org/project/pip/), a package manager or a @@ -37,13 +43,8 @@ a way to test changes and contribute fixes in an instant. To run the book in Codespaces, click on the link below. -
- -
Open in GitHub Codespaces
-
+[![Open in GitHub +Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=447558863) You should [see](https://github.com/geocompx/geocompy/issues/114) something like this, the result of running all the code in the book by diff --git a/README.qmd b/README.qmd index 064cb915..0bb9b02b 100644 --- a/README.qmd +++ b/README.qmd @@ -8,9 +8,12 @@ format: gfm [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=447558863) - +Geocomputation with Python is an open source book project that will be published as a physical book. +We are developing it in the open and publishing an up-to-date online version at . -Running the code in this book requires the following: +## Dependencies + +Running the code that is part of Geocomputation with Python (geocompy for short) requires the following dependencies to be installed: 1. Python dependencies, which can be installed with [`pip`](https://pypi.org/project/pip/), a package manager or a [Docker](https://docs.docker.com/get-docker/) container (see below) 2. An integrated development environment (IDE) such as [VS Code](https://code.visualstudio.com/) (running locally or on [Codespaces](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=447558863)/other host) or [Jupyter Notebook](https://github.com/geocompx/geocompy/tree/main/ipynb) for running and exploring the Python code interactively