https://trkin.github.io/code-style-guide/categories/placeholders/Recent content in Placeholders on TRK CodeHugo -- gohugo.ioenhttps://trkin.github.io/code-style-guide/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://trkin.github.io/code-style-guide/docs/getting-started/ <div class="pageinfo pageinfo-primary"> <p>This is a placeholder page that shows you how to use this template site.</p> </div> <p>Information in this section helps your user try your project themselves.</p> <ul> <li> <p>What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.</p> </li> <li> <p>Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.</p> </li> </ul> <p>Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.</p> <h2 id="prerequisites">Prerequisites<a class="td-heading-self-link" href="#prerequisites" aria-label="Heading self-link"></a></h2> <p>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?</p> <h2 id="installation">Installation<a class="td-heading-self-link" href="#installation" aria-label="Heading self-link"></a></h2> <p>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?</p> <h2 id="setup">Setup<a class="td-heading-self-link" href="#setup" aria-label="Heading self-link"></a></h2> <p>Is there any initial setup users need to do after installation to try your project?</p> <h2 id="try-it-out">Try it out!<a class="td-heading-self-link" href="#try-it-out" aria-label="Heading self-link"></a></h2> <p>Can your users test their installation, for example by running a command or deploying a Hello World example?</p>