Add README and LICENSE
This commit is contained in:
Родитель
3b647a41b6
Коммит
d1887ac989
|
@ -0,0 +1,19 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
|
@ -0,0 +1,60 @@
|
||||||
|
# WWT Docs Hub website: Source Code
|
||||||
|
|
||||||
|
This repository contains the source code for the hub page of
|
||||||
|
|
||||||
|
### https://docs.worldwidetelescope.org/
|
||||||
|
|
||||||
|
If you’re just interested in the documentation itself, you should go to that
|
||||||
|
website. If you’re interested in *contributing* to that website, you’ve come
|
||||||
|
to the right place!
|
||||||
|
|
||||||
|
|
||||||
|
## Quick Start for the Initiated
|
||||||
|
|
||||||
|
The manual 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]. Once you have Zola 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-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.
|
||||||
|
|
||||||
|
[AAS WorldWide Telescope User Manual]: https://docs.worldwidetelescope.org/user-docs-hub/
|
||||||
|
[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
|
||||||
|
|
||||||
|
The AAS WorldWide Telescope system is a [.NET Foundation] project managed by
|
||||||
|
the non-profit [American Astronomical Society] (AAS). Work on WWT has been
|
||||||
|
supported by the AAS, the US [National Science Foundation] (grants [1550701]
|
||||||
|
and [1642446]), the [Gordon and Betty Moore Foundation], and [Microsoft].
|
||||||
|
|
||||||
|
[.NET Foundation]: https://dotnetfoundation.org/
|
||||||
|
[American Astronomical Society]: https://aas.org/
|
||||||
|
[National Science Foundation]: https://www.nsf.gov/
|
||||||
|
[1550701]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1550701
|
||||||
|
[1642446]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1642446
|
||||||
|
[Gordon and Betty Moore Foundation]: https://www.moore.org/
|
||||||
|
[Microsoft]: https://www.microsoft.com/
|
Загрузка…
Ссылка в новой задаче