forked from hsist/freifunk.hackerspace.ist
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
36 lines
1.4 KiB
36 lines
1.4 KiB
4 years ago
|
---
|
||
|
|
title: "Getting Started"
|
||
|
|
linkTitle: "Getting Started"
|
||
|
|
weight: 2
|
||
|
|
description: >
|
||
|
|
What does your user need to know to try your project?
|
||
|
|
---
|
||
|
|
|
||
|
|
{{% pageinfo %}}
|
||
|
|
This is a placeholder page that shows you how to use this template site.
|
||
|
|
{{% /pageinfo %}}
|
||
|
|
|
||
|
|
Information in this section helps your user try your project themselves.
|
||
|
|
|
||
|
|
* What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.
|
||
|
|
|
||
|
|
* Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.
|
||
|
|
|
||
|
|
Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed?
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
Is there any initial setup users need to do after installation to try your project?
|
||
|
|
|
||
|
|
## Try it out!
|
||
|
|
|
||
|
|
Can your users test their installation, for example by running a command or deploying a Hello World example?
|