Update README to recommend SHARK-1.0 for now - Githubissues

nod-ai / SHARK

SHARK - High Performance Machine Learning Distribution

Apache License 2.0

1.4k stars 169 forks source link

Update README to recommend SHARK-1.0 for now #2087

Closed one-lithe-rune closed 4 months ago

one-lithe-rune commented 4 months ago

Motivation

When people just want an image generator its too easy for them to grab a not yet working Shark2 version from main, rather than getting SHARK-1.0.

This updates the README.md to tell them they should be using SHARK-1.0 for now.

Changes

Add a note at the of the top of the README to use SHARK-1.0 whilst rewrite with Turbine is ongoing.
Update installation section to point at SHARK-1.0 branch.
Suggest the latest SHARK-1.0 pre-release as well as stable.
Recommend running the .exe from the command line.