tutor/docs/_release_description.md

Install this version from pip with:

    pip install "tutor[full]==TUTOR_VERSION"

Or download the compiled binaries:

    sudo curl -L "https://github.com/overhangio/tutor/releases/download/TUTOR_VERSION/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
    sudo chmod 0755 /usr/local/bin/tutor

See the [installation docs](https://docs.tutor.overhang.io/install.html) for more installation options and instructions.

## Changes
ci: fix release description format 2022-04-24 13:07:52 +00:00			`Install this version from pip with:`
docs: encourage users to install from pip, and not from the binary 2022-01-08 17:56:37 +00:00
docs: wrap `tutor[full]` in quotes for zsh compatibility The docs recommend commands like: pip install tutor[full] pip install -e ./tutor[full] for installing Tutor. These work fine in bash. For zsh, though, which is now the default on macOS, quotes are needed, otherwise zsh will interpret the brackets as special syntax: pip install "tutor[full]" pip install -e "./tutor[full]" Caveat: I have not tested this myself since I don't own a Mac, but I've read several issue reports to this effect, such as: https://github.com/pypa/pipenv/issues/2830#issuecomment-419593199 2022-04-06 14:23:25 +00:00			`pip install "tutor[full]==TUTOR_VERSION"`
docs: encourage users to install from pip, and not from the binary 2022-01-08 17:56:37 +00:00
ci: fix release description format 2022-04-24 13:07:52 +00:00			`Or download the compiled binaries:`
Better release descriptions By using `github-releases`, we can now generate much better release description blurbs. 2019-04-22 13:14:46 +00:00
Migrate github repo to overhangio organization 2019-06-23 17:56:15 +00:00			`sudo curl -L "https://github.com/overhangio/tutor/releases/download/TUTOR_VERSION/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor`
Fix tutor binary permission error on MacOSX 2019-07-23 15:20:19 +00:00			`sudo chmod 0755 /usr/local/bin/tutor`
Better release descriptions By using `github-releases`, we can now generate much better release description blurbs. 2019-04-22 13:14:46 +00:00
Docs: install -> installation "install" is a verb and "installation" is a noun. 2019-11-22 08:31:26 +00:00			`See the [installation docs](https://docs.tutor.overhang.io/install.html) for more installation options and instructions.`
Better release descriptions By using `github-releases`, we can now generate much better release description blurbs. 2019-04-22 13:14:46 +00:00
Clarify the RAM requirements, especially for Mac OS. Close #299. 2020-03-16 17:12:24 +00:00			`## Changes`
ci: modernize github release script We address the following issues in CI: - Node 12 deprecation: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/ To do that we upgrade actions/checkout and actions/setup-python to v3. - Deprecated set-output command: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ - Get rid of the actions/upload-files-to-a-github-release action to use the gh script which ships by default in GitHub hosted runners: https://github.com/cli/cli Unfortunately we could not get rid of the ugly `sed` in `make release-description`. I wish we could use `envsubst` but it's not available on GitHub action runners. 2022-11-29 11:43:22 +00:00