readme: add information section
[nit.git] / Makefile
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2008 Jean Privat <jean@pryen.org>
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 NITCOPT=
18
19 # Additional program directories (contrib and examples) that are buildable
20 PROGS=$(dir $(wildcard examples/*/Makefile contrib/*/Makefile))
21
22 all: tools man
23 @echo ""
24 @echo "Congratulations! Nit was succesfully compiled."
25 @echo "To configure your shell environment, execute the following command:"
26 @echo " source misc/nit_env.sh install"
27
28 # Compile all programs in $PROGS
29 full: all
30 for m in $(PROGS); do $(MAKE) -C "$$m" || exit 1; done
31
32 docs: doc/stdlib/index.html doc/nitc/index.html
33
34 tools:
35 cd src; make
36
37 bin/nitdoc:
38 cd src; make ../bin/nitdoc
39
40 bin/nitls:
41 cd src; make ../bin/nitls
42
43 doc/stdlib/index.html: bin/nitdoc bin/nitls
44 @echo '***************************************************************'
45 @echo '* Generate doc for NIT standard library *'
46 @echo '***************************************************************'
47 bin/nitdoc lib -d doc/stdlib \
48 --custom-title "Nit Standard Library" \
49 --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
50 --custom-overview-text "<p>Documentation for the standard library of Nit<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
51 --custom-footer-text "Nit standard library. Version $$(git describe)." \
52 --github-upstream "nitlang:nit:master" \
53 --github-base-sha1 "$$(git rev-parse HEAD)" \
54 --github-gitdir "." \
55 --source "https://github.com/nitlang/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L" \
56 --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
57 --piwik-site-id "2" \
58
59 doc/nitc/index.html: bin/nitdoc bin/nitls
60 bin/nitdoc lib src/nit*.nit src/test_*.nit -d doc/nitc \
61 --private \
62 --custom-title "Nit Compilers and Tools" \
63 --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
64 --custom-overview-text "<p>Documentation for the Nit tools<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
65 --custom-footer-text "Nit tools. Version $$(git describe)." \
66 --github-upstream "nitlang:nit:master" \
67 --github-base-sha1 "$$(git rev-parse HEAD)" \
68 --github-gitdir "." \
69 --source "https://github.com/nitlang/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L" \
70 --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
71 --piwik-site-id "3"
72
73 man:
74 $(MAKE) -C share/man
75
76 clean:
77 rm -rf -- doc/stdlib doc/nitc || true
78 cd c_src; make clean
79 cd src; make clean
80 cd tests; make clean
81 cd share/man; make clean
82 for m in $(PROGS); do \
83 $(MAKE) clean -C "$$m"; \
84 done || true