Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/worldwidetelescope/worldwide-telescope-diy-planetarium-dome-guide

The WorldWide Telescope Do-It-Yourself Planetarium Dome Guide
https://github.com/worldwidetelescope/worldwide-telescope-diy-planetarium-dome-guide

Last synced: about 1 month ago
JSON representation

The WorldWide Telescope Do-It-Yourself Planetarium Dome Guide

Awesome Lists containing this project

README

        

[![Build Status](https://dev.azure.com/aasworldwidetelescope/WWT/_apis/build/status/WorldWideTelescope.worldwide-telescope-diy-planetarium-dome-guide?branchName=master)](https://dev.azure.com/aasworldwidetelescope/WWT/_build/latest?definitionId=15&branchName=master)

# WWT D.I.Y. Planetarium Dome Guide: Source Code

This repository contains the source code for the [WWT Do-It-Yourself Planetarium Dome Guide].
The `master` branch of this repo gets published here:

### https://docs.worldwidetelescope.org/diy-planetarium-dome/1/

[WWT Do-It-Yourself Planetarium Dome Guide]: https://docs.worldwidetelescope.org/diy-planetarium-dome/1/

If you’re just interested in the documentation itself, you should go to that
website. If you’re interested in *contributing* to this documentation, you’ve
come to the right place!

## Quick Start for the Initiated

The guide is a static site written in [CommonMark Markdown] and processed
with [Zola]. Zola is distributed as a single executable so it is ridiculously
[easy to install][install-zola].

This repository is themed by referencing [zola-wwtguide] as a submodule, so
upon first checkout you’ll have to run:

```
git submodule update --init
```

Once everything is set up, all you have to do is run

```
zola serve
```

to build the site and serve it locally for testing. The command `zola check`
will check the build and verify that outgoing links are valid. Zola has
[lots of documentation][zola-docs].

[CommonMark Markdown]: https://commonmark.org/
[Zola]: https://getzola.org/
[install-zola]: https://www.getzola.org/documentation/getting-started/installation/
[zola-wwtguide]: https://github.com/WorldWideTelescope/zola-wwtguide
[zola-docs]: https://www.getzola.org/documentation/getting-started/overview/

Merges to `master` will be published automatically using WWT’s continuous
deployment infrastructure.

## Contributing

Contributions are welcome! If you’re new to the project, please see the
[WWT Contributors’ Guide] and the [WWT Code of Conduct]. We operate with a
standard [fork-and-pull] model.

[WWT Contributors’ Guide]: https://worldwidetelescope.github.io/contributing/
[WWT Code of Conduct]: https://worldwidetelescope.github.io/code-of-conduct/
[fork-and-pull]: https://help.github.com/en/articles/about-collaborative-development-models

## Acknowledgments

Work on the WorldWide Telescope system has been supported by the [American
Astronomical Society] (AAS), the [.NET Foundation], and other partners. See [the
WWT user website][acks] for details.

[American Astronomical Society]: https://aas.org/
[.NET Foundation]: https://dotnetfoundation.org/
[acks]: https://worldwidetelescope.org/about/acknowledgments/