Skip to content

Commit

Permalink
feature: add default install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan-Zollinger committed Jan 16, 2024
1 parent 233d521 commit aa9fc5a
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<img src="images/gracker-logo.svg" alt="Gracker - The Grocery Tracker" width="250">

// [![Build](https://github.com/PeanutButter-Unicorn/{{projectName}}/actions/workflows/maven.yml/badge.svg)](https://github.com/PeanutButter-Unicorn/{{projectName}}/actions)
// ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/PeanutButter-Unicorn/{{projectName}})
// ![GitHub](https://img.shields.io/github/license/PeanutButter-Unicorn/{{projectName}})
Expand All @@ -9,5 +7,38 @@
## Summary


### Install

<details><summary>Windows</summary>
<ol>
<li>Download latest windows binary</li>
<li>Move executable to dedicated directory, ie <code>"C:\Program Files\Jonathan is so cool\"</code></li>
<li>Add directory to your PATH</li>

```PowerShell
"C:\Program Files\my-directory\" |
if (!($env:Path -like "*$_*"))
{
$env:Path = "$( $env:Path );$_"
}
```

</ol>
</details>

<details><summary>Linux</summary>
<ol>
<li>Download latest linux binary</li>
<li>Add to <code>$HOME\bin\</code> directory</li>
</ol>
</details>

___



### Want to get involved?
See our **!!fix me!!** [contributing](Contributing.md) doc before taking a whack at any **!!fix me!!** [open issues](https://github.com/PeanutButter-Unicorn/{{projectName}}/issues).
See our [contributing] doc before taking a whack at any [open issues].

[contributing]:Contributing.md
[open issues]:issues

0 comments on commit aa9fc5a

Please sign in to comment.