Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: clarify WSL-2 may require additional config in the docs #933

Merged
merged 1 commit into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
chore: clarify WSL-2 may require additional config
  • Loading branch information
rudokemper committed Jul 24, 2023
commit 4bf4c36e79eaf5d603430927f978c1fc4893cdaf
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

**Terrastories** is a geostorytelling application built for indigenous and other local communities to locate and map their own oral storytelling traditions about places of significant meaning or value to them.

It is a dockerized Rails / React app that uses [**Mapbox GL JS**](https://mapbox.com) / [**MapLibre GL JS**](https://maplibre.com/) to help users locate content geographically on an interactive map. As a local-first application, Terrastories is designed to work entirely offline, so that remote communities can access the application entirely without needing internet connectivity.
It is a dockerized Rails + React app that uses [**Mapbox GL JS**](https://mapbox.com) / [**MapLibre GL JS**](https://maplibre.com/) to help users locate content geographically on an interactive map. As a local-first application, Terrastories is designed to work entirely offline, so that remote communities can access the application entirely without needing internet connectivity.

The Terrastories interface is principally composed of an interactive map and a sidebar with media content. Users can explore the map and click on activated points to see the stories associated with those points. Alternatively, users can interact with the sidebar and click on stories to see where in the landscape these narratives took place.

By means of a content management system, users with the right level of access can also explore, add, edit, remove, and import stories, or set them as restricted so that they are viewable only with a special login. Users can design and customize the content of the interactive map entirely.

Learn more about Terrastories on [our website](https://terrastories.app/).

*The remainder of the documentation on Github is for developers. For documentation on using or installing Terrastories, please visit the Terrastories Support Materials at **[https://docs.terrastories.app/](https://docs.terrastories.app/)***
*The remainder of the documentation on Github is **for developers**. For documentation on using or setting up Terrastories on an online, offline "Field Kit", or mesh network server, please visit the Terrastories Support Materials at **[https://docs.terrastories.app/](https://docs.terrastories.app/)***

![](documentation/terrastories.gif)
###### *Terrastories: Matawai Konde 1.0 (October 2018)*
Expand All @@ -28,7 +28,7 @@ Local development and offline mode both require Docker to be installed.

Download and install [Docker](https://www.docker.com/products/docker-desktop/) for your platform.

> NOTE: Windows requires WSL 2.0 or virtualization in order to work.
> NOTE: Windows requires WSL 2.0 or virtualization in order to work. Additionally, it is possible that you may need to configure some additional settings for Terrastories to properly work on Windows.

#### Tileserver (Offline "Field Kit" Mode)

Expand Down
2 changes: 1 addition & 1 deletion documentation/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Docker is a platform that serves to deliver software in packages called containe
Setup instructions for Docker: https://docs.docker.com/engine/install/

* On Linux, users should run all docker commands with `sudo` or check the [official documentation](https://docs.docker.com/install/linux/linux-postinstall/) to manage Docker as a non-root user.
* On Windows, Docker should install WSL-2 (Windows Subsystem for Linux 2) through which you should set up Terrastories.
* On Windows, Docker should install WSL-2 (Windows Subsystem for Linux 2) through which you should set up Terrastories. However, it is possible that you may need to configure some additional settings for Terrastories to properly work on Windows.

## Setup the application
1. Create a fork of the Terrastories/terrastories repository. Now clone the repository locally to your computer.
Expand Down