Merge branch 'main' of https://github.com/casualsnek/cassowary

README.md

@@ -15,7 +15,7 @@ Give a star ⭐ or follow if you find this project useful
  - Easily accessing guest filesystem from host
  - Easily access host filesystem from windows
  - Easy to use configuration utility
-- Creating application launcher for windows application easily
+ - Creating application launcher for windows application easily
 
 ## This README consists of instructions for:
 1. [Setting up Windows VM with virt-manager](docs/1-virt-manager.md)
@@ -25,13 +25,14 @@ Give a star ⭐ or follow if you find this project useful
 5. How can i help?
 
 # 4. Building cassowary from source
-Install wine first in order to build windows application on linux, internet is required to download python binary for setup 
+Install [wine](https://wiki.winehq.org/Download) first in order to build windows application on linux, internet is required to download python binary for setup 
 
 ```
-$ git clone https:// github.com/casualsnek/cassowary
+$ git clone https://github.com/casualsnek/cassowary
 $ cd cassowary
 $ ./buildall.sh
 ```
+If `buildall.sh` produces error such as `bash: ./buildall.sh: Permission denied`, run this command `chmod +x buildall.sh` and run `./buildall.sh` again.
 
 This will result a dist folder inside app-linux which contains the installed wheel file
 also a bin folder will be created in app-windows containing the setup files

app-win/build.sh

@@ -6,7 +6,7 @@ download_python()
   if [ ! -f /tmp/pysetup.exe ]
   then
       echo "Downloading python"
-      wget https://www.python.org/ftp/python/3.9.6/python-3.9.6-amd64.exe -O /tmp/pyseup.exe
+      wget https://www.python.org/ftp/python/3.9.6/python-3.9.6-amd64.exe -O /tmp/pysetup.exe
   fi
   checksum="$(md5sum /tmp/pysetup.exe | awk '{ print $1 }')"
 }

buildall.sh

@@ -1,10 +1,10 @@
 #!/usr/bin/env bash
 echo "==> Building linux component"
-cd ./app-linux
-build.sh
+cd app-linux
+./build.sh
 echo "==> Done"
 cd ..
-cd "==> Building windows component"
-cd ./app-win
-build.sh
+echo "==> Building windows component"
+cd app-win
+./build.sh
 echo "==> Done"

docs/1-virt-manager.md

@@ -36,7 +36,7 @@ To do this create the folder `~/.config/libvirt/` and inside this folder create
 
 ```
 $ mkdir -p ~/.config/libvirt
-$ echo "uri_default = "qemu:///system"" >> ~/.config/libvirt/libvirt.conf
+$ echo "uri_default = \"qemu:///system\"" >> ~/.config/libvirt/libvirt.conf
 ```
 
 Now you will need to restart for all the changes to take place.
@@ -105,8 +105,12 @@ with:
 - Go to Video QXL section and set **Model** to **VirtIO** and check the 3D acceleration option;
 - (if after those two changes all you get is a black screen, revert those changes. This could happen with nVidia graphics card);
 - Start the VM by clicking the play button on top left (you may need to click the Monitor icon to show the VM screen ). Login to desktop;
-- Open up edge and browse to this page and continue the instructions for installing cassowary.
+- Open up edge and browse to this page and continue the instructions for installing cassowary.:
 
 ---
 
-**Next guide** -> [Installing cassowary on Windows guest and Linux host](2-cassowary-install.md)
+Note: For better 3D performance you can use VmWare or other virtualization platform, ( The IP autodetection and VM auto suspend only works for libvirt based platforms as of now.
+
+---
+
+**Next guide** -> [Installing cassowary on Windows guest and Linux host](2-cassowary-install.md)