From 2769ec22f2ec2e9e6e30de452bac372f49ae0b26 Mon Sep 17 00:00:00 2001 From: cmdr2 Date: Thu, 3 Nov 2022 09:44:07 +0530 Subject: [PATCH] readme.txt for users in the release zip --- installer/How to create the installers.md | 5 ----- installer/readme.txt | 11 +++++++++++ 2 files changed, 11 insertions(+), 5 deletions(-) delete mode 100644 installer/How to create the installers.md create mode 100644 installer/readme.txt diff --git a/installer/How to create the installers.md b/installer/How to create the installers.md deleted file mode 100644 index 8030ff7..0000000 --- a/installer/How to create the installers.md +++ /dev/null @@ -1,5 +0,0 @@ -**Important:** These instructions are for the developers of this project, not for users! The users should use the pre-created zip files for installation. - -Just distribute the `install.bat` or `install.sh` file. - -Running that file will download the invokeAI repository into the same folder as the script, and install the required dependencies. diff --git a/installer/readme.txt b/installer/readme.txt new file mode 100644 index 0000000..d73a027 --- /dev/null +++ b/installer/readme.txt @@ -0,0 +1,11 @@ +Sygil WebUI + +Project homepage: https://github.com/Sygil-Dev/sygil-webui + +Installation on Windows: + Please double-click the 'install.bat' file (while keeping it inside the sygil folder). + +Installation on Linux: + Please open the terminal, and run './install.sh' (while keeping it inside the sygil folder). + +After installation, please run the 'webui.cmd' file (on Windows) or 'webui.sh' file (on Linux/Mac) to start Sygil. \ No newline at end of file