Compare commits
2 Commits
2327d63963
...
ee3bac0d70
Author | SHA1 | Date |
---|---|---|
Alex Palaistras | ee3bac0d70 | |
Alex Palaistras | 400f9f9c57 |
7
Makefile
7
Makefile
|
@ -10,6 +10,7 @@ REMOTE_URL := https://xmpp.org/extensions
|
|||
ENVSUBST = $(call find-cmd,envsubst)
|
||||
SQLITE = $(call find-cmd,sqlite3)
|
||||
TAR = $(call find-cmd,tar)
|
||||
GIT = $(call find-cmd,git)
|
||||
|
||||
# Directory aliases.
|
||||
ROOTDIR := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
|
||||
|
@ -24,6 +25,10 @@ VERBOSE :=
|
|||
## Build and archive docset.
|
||||
build: $(BUILDDIR)$(NAME).tgz
|
||||
|
||||
## Update XEPs in submodule.
|
||||
update:
|
||||
$Q $(GIT) submodule update --remote --recursive
|
||||
|
||||
## Remove all temporary build files.
|
||||
clean:
|
||||
$Q rm -Rf $(BUILDDIR)
|
||||
|
@ -48,7 +53,7 @@ $(CONTENTDIR)Resources/Documents/xep-%.html: $(XEPDIR)xep-%.xml | $(CONTENTDIR)R
|
|||
$(BUILDDIR)$(NAME).tgz: $(XEPS) $(CONTENTDIR)Info.plist
|
||||
$Q $(TAR) --create --gzip --file $(BUILDDIR)$(NAME).tgz -C $(BUILDDIR) $(NAME).docset
|
||||
|
||||
.PHONY: build clean
|
||||
.PHONY: build update clean
|
||||
|
||||
# Conditional command echo control.
|
||||
Q := $(if $(VERBOSE),,@)
|
||||
|
|
14
README.md
14
README.md
|
@ -9,7 +9,7 @@ The source XEPs to be included in the resulting docset are pulled automatically
|
|||
able to build a useful doc-set, and you can do this like so:
|
||||
|
||||
```sh
|
||||
git submodule --remote --recursive
|
||||
git submodule update --remote --recursive
|
||||
```
|
||||
|
||||
Building the docset might fail if the above was not done and this repository wasn't cloned via `git
|
||||
|
@ -26,6 +26,18 @@ Building a new Docset requires a single command and a few dependencies:
|
|||
|
||||
With these dependencies in place, you can just run `make` in the root directory of the repository.
|
||||
|
||||
## Install
|
||||
|
||||
You can install the resulting docset by either using the `build/XEPs.tgz` package directly, or,
|
||||
alternatively, by using the feed hosted here, the URL for which is:
|
||||
|
||||
```
|
||||
https://raw.githubusercontent.com/deuill/xmpp-xep-dash-docset/trunk/XEPs.xml
|
||||
```
|
||||
|
||||
Copying this into your application of choice (Dash, Zeal, etc.) should automatically pull in any
|
||||
future updates to the docset.
|
||||
|
||||
## License
|
||||
|
||||
All code in this repository is covered by the terms of the MIT License, the full text of which can
|
||||
|
|
|
@ -0,0 +1,4 @@
|
|||
<entry>
|
||||
<version>2024.1.0</version>
|
||||
<url>https://github.com/deuill/xmpp-xep-dash-docset/releases/latest/download/XEPs.tgz</url>
|
||||
</entry>
|
2
xeps
2
xeps
|
@ -1 +1 @@
|
|||
Subproject commit f86bc85bc677c1e668e251ba82bbca4953e8023b
|
||||
Subproject commit caa1e57fc0a84a16e77ecb0c9e0c78d100516e5f
|
Loading…
Reference in New Issue