diff --git a/README.md b/README.md index 6ce131493c..f540e7be75 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ # Invoke - Professional Creative AI Tools for Visual Media -## To learn more about Invoke, or implement our Business solutions, visit [invoke.com](https://www.invoke.com/about) - +#### To learn more about Invoke, or implement our Business solutions, visit [invoke.com] + [![discord badge]][discord link] [![latest release badge]][latest release link] [![github stars badge]][github stars link] [![github forks badge]][github forks link] [![CI checks on main badge]][CI checks on main link] [![latest commit to main badge]][latest commit to main link] [![github open issues badge]][github open issues link] [![github open prs badge]][github open prs link] [![translation status badge]][translation status link] Invoke is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. Invoke offers an industry leading web-based UI, and serves as the foundation for multiple commercial products. -**Quick links**: [Installation](https://invoke-ai.github.io/InvokeAI/installation/INSTALLATION/) - [Discord](https://discord.gg/ZmtBAhwWhy) - [Documentation and Tutorials](https://invoke-ai.github.io/InvokeAI) - [Bug Reports](https://github.com/invoke-ai/InvokeAI/issues) - [Contributing](https://invoke-ai.github.io/InvokeAI/contributing/CONTRIBUTING/) +[Installation][installation docs] - [Documentation and Tutorials][docs home] - [Bug Reports][github issues] - [Contributing][contributing docs]
@@ -22,24 +22,30 @@ Invoke is a leading creative engine built to empower professionals and enthusias ## Quick Start -1. Download and unzip the installer from the bottom of the [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest). +1. Download and unzip the installer from the bottom of the [latest release][latest release link]. 2. Run the installer script. -- **Windows**: Double-click on the `install.bat` script. -- **macOS**: Open a Terminal window, drag the file `install.sh` from Finder into the Terminal, and press enter. -- **Linux**: Run `install.sh`. + - **Windows**: Double-click on the `install.bat` script. + - **macOS**: Open a Terminal window, drag the file `install.sh` from Finder into the Terminal, and press enter. + - **Linux**: Run `install.sh`. 3. When prompted, enter a location for the install and select your GPU type. 4. Once the install finishes, find the directory you selected during install. The default location is `C:\Users\Username\invokeai` for Windows or `~/invokeai` for Linux/macOS. -6. Run the launcher script (`invoke.bat` for Windows, `invoke.sh` for macOS and Linux) - the same way you ran the installer script in step 2. -7. Select option 1 to start the application. Once it starts up, open your browser and go to . -8. Open the model manager tab to install a starter model and then you'll be ready to generate. +5. Run the launcher script (`invoke.bat` for Windows, `invoke.sh` for macOS and Linux) the same way you ran the installer script in step 2. +6. Select option 1 to start the application. Once it starts up, open your browser and go to . +7. Open the model manager tab to install a starter model and then you'll be ready to generate. -More detail, including hardware requirements and manual install instructions, are available in the [installation documentation](https://invoke-ai.github.io/InvokeAI/installation/INSTALLATION/). +More detail, including hardware requirements and manual install instructions, are available in the [installation documentation][installation docs]. + +## Troubleshooting, FAQ and Support + +Please review our [FAQ][faq] for solutions to common installation problems and other issues. + +For more help, please join our [Discord][discord link]. ## Features -Full details on features can be found in [our documentation](https://invoke-ai.github.io/InvokeAI/features/). +Full details on features can be found in [our documentation][features docs]. ### Web Server & UI @@ -67,28 +73,31 @@ Invoke features an organized gallery system for easily storing, accessing, and r - Workflow creation & management - Node-Based Architecture -## Troubleshooting, FAQ and Support - -Please review our **[FAQ](https://invoke-ai.github.io/InvokeAI/help/FAQ/)** for solutions to common installation problems and other issues. - -For more help, please join our [Discord][discord link]. - ## Contributing Anyone who wishes to contribute to this project - whether documentation, features, bug fixes, code cleanup, testing, or code reviews - is very much encouraged to do so. -Get started with contributing by reading our [Contribution documentation](https://invoke-ai.github.io/InvokeAI/contributing/CONTRIBUTING/), joining the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) or the GitHub discussion board. +Get started with contributing by reading our [contribution documentation][contributing docs], joining the [#dev-chat] or the GitHub discussion board. We hope you enjoy using Invoke as much as we enjoy creating it, and we hope you will elect to become part of our community. ## Thanks -Invoke is a combined effort of [passionate and talented people from across the world](https://invoke-ai.github.io/InvokeAI/other/CONTRIBUTORS/). We thank them for their time, hard work and effort. +Invoke is a combined effort of [passionate and talented people from across the world][contributors]. We thank them for their time, hard work and effort. Original portions of the software are Copyright © 2024 by respective contributors. +[features docs]: https://invoke-ai.github.io/InvokeAI/features/ +[faq]: https://invoke-ai.github.io/InvokeAI/help/FAQ/ +[contributors]: https://invoke-ai.github.io/InvokeAI/other/CONTRIBUTORS/ +[invoke.com]: https://www.invoke.com/about +[github issues]: https://github.com/invoke-ai/InvokeAI/issues +[docs home]: https://invoke-ai.github.io/InvokeAI +[installation docs]: https://invoke-ai.github.io/InvokeAI/installation/INSTALLATION/ +[#dev-chat]: https://discord.com/channels/1020123559063990373/1049495067846524939 +[contributing docs]: https://invoke-ai.github.io/InvokeAI/contributing/CONTRIBUTING/ [CI checks on main badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/main?label=CI%20status%20on%20main&cache=900&icon=github -[CI checks on main link]:https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Amain +[CI checks on main link]: https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Amain [discord badge]: https://flat.badgen.net/discord/members/ZmtBAhwWhy?icon=discord [discord link]: https://discord.gg/ZmtBAhwWhy [github forks badge]: https://flat.badgen.net/github/forks/invoke-ai/InvokeAI?icon=github @@ -102,6 +111,6 @@ Original portions of the software are Copyright © 2024 by respective contributo [latest commit to main badge]: https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/main?icon=github&color=yellow&label=last%20dev%20commit&cache=900 [latest commit to main link]: https://github.com/invoke-ai/InvokeAI/commits/main [latest release badge]: https://flat.badgen.net/github/release/invoke-ai/InvokeAI/development?icon=github -[latest release link]: https://github.com/invoke-ai/InvokeAI/releases +[latest release link]: https://github.com/invoke-ai/InvokeAI/releases/latest [translation status badge]: https://hosted.weblate.org/widgets/invokeai/-/svg-badge.svg -[translation status link]: https://hosted.weblate.org/engage/invokeai/ \ No newline at end of file +[translation status link]: https://hosted.weblate.org/engage/invokeai/