Merge: doc: fixed some typos and other misc. corrections
[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
18 contrib_dir = ./contrib
19 examples_dir = ./examples
20 all_contribs = $(dir $(wildcard $(contrib_dir)/*/Makefile))
21
22 # Additional program directories (contrib and examples) that are buildable
23 extras = $(filter-out $(contrib_dir)/nitc/,$(all_contribs))
24 extras += $(dir $(wildcard $(examples_dir)/*/Makefile))
25
26 all: tools man
27 @echo ""
28 @echo "Congratulations! Nit was succesfully compiled."
29 @echo "To configure your shell environment, execute the following command:"
30 @echo " source misc/nit_env.sh install"
31
32 more:
33 cd src; make more
34
35 # Compile all programs in `contrib`, `examples` and `src`.
36 #
37 # Furthermore, build the toolchain’s `man` pages.
38 full: all more
39 for directory in $(extras); do \
40 (cd "$${directory}" && $(MAKE)) || exit 1; \
41 done
42
43 docs: doc/stdlib/index.html doc/nitc/index.html
44
45 tools:
46 cd src; make
47
48 bin/nitdoc:
49 cd src; make ../bin/nitdoc
50
51 bin/nitls:
52 cd src; make ../bin/nitls
53
54 doc/stdlib/index.html: bin/nitdoc bin/nitls
55 @echo '***************************************************************'
56 @echo '* Generate doc for NIT standard library *'
57 @echo '***************************************************************'
58 bin/nitdoc lib -d doc/stdlib \
59 --custom-title "Nit Standard Library" \
60 --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
61 --custom-overview-text "<p>Documentation for the standard library of Nit<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
62 --custom-footer-text "Nit standard library. Version $$(git describe)." \
63 --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
64 --piwik-site-id "2" \
65
66 doc/nitc/index.html: bin/nitdoc bin/nitls
67 bin/nitdoc lib src/nit*.nit src/test_*.nit -d doc/nitc \
68 --private \
69 --custom-title "Nit Compilers and Tools" \
70 --custom-brand "<a href=\"http://nitlanguage.org/\">Nitlanguage.org</a>" \
71 --custom-overview-text "<p>Documentation for the Nit tools<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
72 --custom-footer-text "Nit tools. Version $$(git describe)." \
73 --piwik-tracker "pratchett.info.uqam.ca/piwik/" \
74 --piwik-site-id "3"
75
76 man:
77 # Setup PATH to find nitc
78 PATH=$$PWD/bin:$$PATH $(MAKE) -C share/man
79
80 clean:
81 rm -rf -- doc/stdlib doc/nitc || true
82 cd c_src; make clean
83 cd src; make clean
84 cd tests; make clean
85 cd share/man; make clean
86 -for directory in $(extras); do \
87 (echo "CLEANING $$directory" && cd "$$directory" && $(MAKE) clean); \
88 done
89 @echo ""
90 @echo "Nit was succesfully cleaned."