README: document nit_env.sh

[nit.git] / Makefile

diff --git a/Makefile b/Makefile
index ae0c1d2..da0acf0 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -16,33 +16,65 @@
 
 NITCOPT=
 
-all: tools doc/stdlib/index.html
+# Additional program directories (contrib and examples) that are buildable
+PROGS=$(dir $(wildcard examples/*/Makefile contrib/*/Makefile))
+
+all: tools man
+
+# Compile all programs in $PROGS
+full: all
+       for m in $(PROGS); do $(MAKE) -C "$$m" || exit 1; done
 
 docs: doc/stdlib/index.html doc/nitc/index.html
-       cd doc; make
 
 tools:
        cd src; make
 
-doc/stdlib/index.html: tools
+bin/nitdoc:
+       cd src; make ../bin/nitdoc
+
+bin/nitls:
+       cd src; make ../bin/nitls
+
+doc/stdlib/index.html: bin/nitdoc bin/nitls
        @echo '***************************************************************'
        @echo '* Generate doc for NIT standard library                       *'
        @echo '***************************************************************'
-       bin/nitdoc lib/*.nit -d doc/stdlib --public --overview-text '<p>Documentation for the standard library of Nit</p>' --footer-text 'Nit standard library. Version '`git describe -- lib`'.'
+       bin/nitdoc lib -d doc/stdlib \
+               --custom-title "Nit Standard Library" \
+               --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
+               --custom-overview-text "<p>Documentation for the standard library of Nit<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
+               --custom-footer-text "Nit standard library. Version $$(git describe)." \
+               --github-upstream "nitlang:nit:master" \
+               --github-base-sha1 "$$(git rev-parse HEAD)" \
+               --github-gitdir "." \
+               --source "https://github.com/nitlang/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L" \
+               --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
+               --piwik-site-id "2" \
+
+doc/nitc/index.html: bin/nitdoc bin/nitls
+       bin/nitdoc lib src/nit*.nit src/test_*.nit -d doc/nitc \
+               --private \
+               --custom-title "Nit Compilers and Tools" \
+               --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
+               --custom-overview-text "<p>Documentation for the Nit tools<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
+               --custom-footer-text "Nit tools. Version $$(git describe)." \
+               --github-upstream "nitlang:nit:master" \
+               --github-base-sha1 "$$(git rev-parse HEAD)" \
+               --github-gitdir "." \
+               --source "https://github.com/nitlang/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L" \
+               --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
+               --piwik-site-id "3"
 
-doc/nitc/index.html: tools
-       bin/nitdoc src/nitc.nit src/nitdoc.nit -d doc/nitc --overview-text '<p>Documentation for the nit compiler</p>' --footer-text 'Nit compiler. Version '`git describe`'.'
+man:
+       $(MAKE) -C share/man
 
 clean:
-       rm -rf -- .nit_compile 2> /dev/null || true
+       rm -rf -- doc/stdlib doc/nitc || true
        cd c_src; make clean
        cd src; make clean
-       cd doc; make clean
        cd tests; make clean
-
-distclean: clean
-       rm -rf -- bin/nitc bin/nitdoc bin/nits doc/stdlib doc/nitc/ 2> /dev/null || true
-       cd c_src; make distclean
-       cd src/parser; make distclean
-       cd doc; make distclean
-       cd tests; make distclean
+       cd share/man; make clean
+       for m in $(PROGS); do \
+               $(MAKE) clean -C "$$m"; \
+               done || true