Skip to content

Commit

Permalink
Alter README with more detailed instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
poikilotherm committed Sep 25, 2023
1 parent 7610f67 commit 2a445fb
Showing 1 changed file with 39 additions and 12 deletions.
51 changes: 39 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,52 @@
# dataversecommunity.global

Create a venv if you haven't already.
This GitHub project hosts the sources from which the GDCC website at https://dataversecommunity.global is built.
Builds are automated and any commited changes will be released by automation.

```
python3 -m venv venv
```
You can do smaller edits using the GitHub integrated web editor for files and change the Markdown based content.
For larger changes, we recommend working with a local setup, also allowing to preview your changes.
See below for a tutorial how to start your local setup.

Activate the venv.
## Prepare your environment

First, install Python 3.10 (or later).

Additionally, you need to [install `poetry >= 1.2.0`](https://python-poetry.org/docs/#installation), either globally, or within an environment of your choice.
As a project, we chose `poetry` to manage our dependencies, builds, and deposits as a state of the art solution within the Python ecosystem.

## Get the source code

Next, you need to obtain a version of the website "source code".

You can either download it as a zipped package or clone the whole Git repository.
You can clone the repository and enter the project directory as follows:

```shell
git clone https://github.com/gdcc/dataversecommunity.global.git
cd dataversecommunity.global
```
source venv/bin/activate
```

Install requirements if you haven't already.
## Build the website for preview

To build the website in your *poetry* environment, run the
following commands from the project root:

```shell
poetry install
poetry run task docs-build
```
pip install -r requirements.txt

On Linux you can use `xdg-open`, on Mac `open` to see the built output in your browser:
```shell
xdg-open build/html/index.html
```

Build the site.
Or use [`sphinx-autobuild`](https://github.com/executablebooks/sphinx-autobuild) to enable a self-updating preview service:

```shell
poetry install
poetry run task docs-live
```
make html
```

The page will automatically be opened for you in a browser window or tab.
**Note:** enabling auto-reload without user interaction requires you to install the "LiveReload" extension for your browser.

0 comments on commit 2a445fb

Please sign in to comment.