diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3bea1bf..98fe342 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -29,16 +29,9 @@ jobs: - name: Build the docset run: | make - make zip - - name: Upload the ST docset + - name: Upload the docsets uses: actions/upload-artifact@v4 with: - name: sublime-text.docset.tgz - path: out/sublime-text.docset.tgz - - - name: Upload the SM docset - uses: actions/upload-artifact@v4 - with: - name: sublime-merge.docset.tgz - path: out/sublime-merge.docset.tgz + name: docset-bundle + path: out/sublime-*.docset diff --git a/README.md b/README.md index ad4a0d9..fd83be7 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # [Sublime Text Docset][self] [Dash][] and [Zeal][] docset for [Sublime Text][st]’s official -[documentation][st-docs]. There is also a small docset for Sublime Merge. +[documentation][st-docs]. There is also a small docset for [Sublime Merge][sm]. ## Installation Download from GitHub Releases or build yourself with the instructions below. -- If you have a `sublime-text.docset.tgz` from GitHub, extract it somewhere. +- If you have a `docset-bundle.zip` from GitHub, extract it somewhere. - If you build yourself, `sublime-text.docset` will be in the `out` folder. @@ -16,6 +16,9 @@ We hope to have a distribution channel [eventually][distribution]. ### Install a local folder to Dash +It may be possible to just double-click `sublime-text.docset`, +but that hasn't been tested. If that doesn't work: + 1. Open Dash. 1. Cmd+, 1. Open the "Docsets" tab. @@ -25,9 +28,6 @@ We hope to have a distribution channel [eventually][distribution]. 1. Optionally change the keyword. 1. Repeat for `out/sublime-merge.docset`. -It may be possible to just double-click `sublime-text.docset`, -but that hasn't been tested. - ### Install a local folder to Zeal If you have default Linux folders, `make install-linux`. Otherwise: @@ -65,5 +65,6 @@ If you have default Linux folders, `make install-linux`. Otherwise: [Zeal]: https://zealdocs.org [st]: https://www.sublimetext.com/ [st-docs]: https://www.sublimetext.com/docs/index.html +[sm]: https://www.sublimemerge.com/ [dashing]: https://github.com/technosophos/dashing#readme [distribution]: https://github.com/SublimeText/sublime-text-docset/issues/12