ca70560b1a3831842882dd7c47adf49c5d740f82
[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, just `./generate-doc.sh <ffmpeg-src>`.
19
20 In case of a major CSS update, please also update the `style.min.css` file in
21 the main FFmpeg repo:
22   $ cat /path/to/ffmpeg-web/src/css_credit /path/to/ffmpeg-web/htdocs/css/{bootstrap.min.css,style.min.css} > /path/to/ffmpeg/doc/style.min.css
23
24
25 WEBSITE DEVELOPERS INSTRUCTIONS
26 -------------------------------
27
28 npm, lessc and bower are required to generate the website in development.[2]
29
30 Type `make DEV=1` to generate the website for development.
31 Type `make clean DEV=1` to remove the generated files.
32
33 In development mode, the external dependencies are downloaded through bower.
34
35 Thanks to lessc, you can edit the *.less sources and see the changes on your
36 browser without having to reload it.
37
38
39 -----
40
41 [1] lessc is available on the packages of some distributions.
42 Otherwise, follow the instructions in [2].
43 lessc depends on lots of stuff including npm, so if you wish to use a lighter version,
44 you might want to check out the C++ version: http://www.vanderkroef.net/clessc.html
45
46 [2] Install instructions, 2 methods:
47
48 - Install everything globally (root required)
49   - Install npm from the packages or the sources: http://nodejs.org/
50   - Install lessc and bower using npm:
51     $ sudo npm install -g bower less
52
53 - Install only npm globally
54   - Install npm from the packages or the sources: http://nodejs.org/
55   - Install lessc and bower in the current directory using npm:
56     $ npm install bower less
57   - Add the path to your environment:
58     $ export PATH=`pwd`/node_modules/bower/bin:`pwd`/node_modules/less/bin:$PATH