93854ee86e306fccd5fef74757a73e23c854b4f1
[ffmpeg-web.git] / README
1 ffmpeg.org official website
2
3
4 GENERATE THE WEBSITE
5 --------------------
6
7 `lessc` is required to generate CSS of the website.[1]
8
9 Type `make` to generate the website.
10 Type `make clean` to remove the generated files.
11
12
13 GENERATE THE DOCUMENTATION
14 --------------------------
15
16 /!\ None of the generated versions of the website contain the documentation.
17
18 To generate the documentation pages:
19 - Add the HTML wrappers to your environment:
20   $ export FFMPEG_HEADER1="$(cat src/template_head1 src/template_doctitle src/template_head_prod)"
21   $ export FFMPEG_HEADER2="$(cat src/template_head2 src/template_doctitle src/template_head3)"
22   $ export FFMPEG_FOOTER="$(cat src/template_footer1 src/template_footer_prod src/template_footer2)"
23 - Get the main ffmpeg repo:
24   $ git clone git://source.ffmpeg.org/ffmpeg.git
25 - Compile the documentation using the ffmpeg main repo Makefile:
26   $ make doc
27 - Copy the generated HTML files inside the website:
28   $ cp /path/to/ffmpeg/doc/*.html /path/to/ffmpeg-web/htdocs/
29
30 In case of a major CSS update, please also update the `style.min.css` file in
31 the main FFmpeg repo:
32   $ cat /path/to/ffmpeg-web/htdocs/css/{bootstrap.min.css,style.min.css} > /path/to/ffmpeg/doc/style.min.css
33
34
35 WEBSITE DEVELOPERS INSTRUCTIONS
36 -------------------------------
37
38 npm, lessc and bower are required to generate the website in development.[2]
39
40 Type `make DEV=1` to generate the website for development.
41 Type `make clean DEV=1` to remove the generated files.
42
43 In development mode, the external dependencies are downloaded through bower.
44
45 Thanks to lessc, you can edit the *.less sources and see the changes on your
46 browser without having to reload it.
47
48
49 -----
50
51 [1] lessc is available on the packages of some distributions.
52 Otherwise, follow the instructions in [2].
53 lessc depends on lots of stuff including npm, so if you wish to use a lighter version,
54 you might want to check out the C++ version: http://www.vanderkroef.net/clessc.html
55
56 [2] Install instructions, 2 methods:
57
58 - Install everything globally (root required)
59   - Install npm from the packages or the sources: http://nodejs.org/
60   - Install lessc and bower using npm:
61     $ sudo npm install -g bower less
62
63 - Install only npm globally
64   - Install npm from the packages or the sources: http://nodejs.org/
65   - Install lessc and bower in the current directory using npm:
66     $ npm install bower less
67   - Add the path to your environment:
68     $ export PATH=`pwd`/node_modules/bower/bin:`pwd`/node_modules/less/bin:$PATH