[Misc] Install

Install

To use Zukit framework in your project, you need to load its classes before referring to the class that inherits the framework methods. There are many ways to do this, but the simplest is install the framework as a subtree in your project. To simplify this process, I wrote a bash script [zukit.sh] that does all the necessary operations. You will need to download the script from the remote repository and then execute it. Before executing the script, you can change it and remove unnecessary (in your opinion) operations:

# retrieve 'zukit.sh' from the repository
$ curl 'https://raw.githubusercontent.com/picasso/zukit/master/zukit.sh' > zukit.sh

# maybe you have to give the script permission to run
# chmod +x zukit.sh

# execute script
$ sh zukit.sh

To update Zukit to the current version, you need to run the subtree pull command. You can change the commit message at your discretion:

# pull updates from Zukit
$ git subtree pull --prefix=zukit zukit master --squash -m 'Zukit updated'

See Git sparse-checkout and Git subtree for complete docs and examples.

❗ Памятка. Попробовать потом иначе

After installation, you can remove zukit.sh or add it to your .gitignore file.