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