From: Adam Koszek via ffmpeg-devel <ffmpeg-devel@ffmpeg.org>
To: ffmpeg-devel@ffmpeg.org
Cc: Adam Koszek <adam@koszek.com>
Subject: [FFmpeg-devel] [PATCH 1/1] Fix the built instruction.
Date: Thu, 13 Nov 2025 13:24:53 -0800
Message-ID: <20251113212503.26963-2-adam@koszek.com> (raw)
In-Reply-To: <20251113212503.26963-1-adam@koszek.com>
---
README | 74 ++++++++++++++++++++++++++-----------------------
generate-doc.sh | 4 +--
2 files changed, 42 insertions(+), 36 deletions(-)
diff --git a/README b/README
index 4b1ce67..1707fad 100644
--- a/README
+++ b/README
@@ -1,59 +1,65 @@
ffmpeg.org official website
+PREREQUISITES
+-------------
-GENERATE THE WEBSITE
---------------------
+You must have some tools. To install them:
-`lessc` and `clean-css` are required to generate CSS of the website.[1]
+ $ npm install -g bower less clean-css
-Type `make` to generate the website.
-Type `make clean` to remove the generated files.
+Refer to relevant info at http://nodejs.org/ and https://github.com/nvm-sh/nvm to get
+appropriate tool version. Test:
+ $ lessc --version
+ lessc 4.4.2 (Less Compiler) [JavaScript]
-GENERATE THE DOCUMENTATION
---------------------------
+ $ bower --version
+ 1.8.14
-/!\ None of the generated versions of the website contain the documentation.
+On macOS, you additionally need:
-To generate the documentation pages, just `./generate-doc.sh <ffmpeg-src>`.
+ brew install makeinfo texinfo texi2html
-In case of a major CSS update, please also update the `style.min.css` file in
-the main FFmpeg repo
- $ cp htdocs/css/{bootstrap.min.css,style.min.css} /path/to/ffmpeg/doc/
+Add the path to your environment:
+ export PATH=`pwd`/node_modules/bower/bin:`pwd`/node_modules/less/bin:$PATH
+GENERATE THE WEBSITE
+--------------------
-WEBSITE DEVELOPERS INSTRUCTIONS
--------------------------------
+To generate the website in development mode type:
-npm, lessc and bower are required to generate the website in development.[2]
+ make DEV=1
-Type `make DEV=1` to generate the website for development.
-Type `make clean DEV=1` to remove the generated files.
+To remove generates files type:
-In development mode, the external dependencies are downloaded through bower.
+ make DEV=1 clean
+In development mode, the external dependencies are downloaded through bower.
Thanks to lessc, you can edit the *.less sources and see the changes on your
browser without having to reload it.
+Whenever you're ready for production build, the respective commands are:
+
+ make
+ make clean
------
+GENERATE THE DOCUMENTATION
+--------------------------
-[1] lessc is available on the packages of some distributions.
-Otherwise, follow the instructions in [2].
-lessc depends on lots of stuff including npm, so if you wish to use a lighter version,
-you might want to check out the C++ version: http://www.vanderkroef.net/clessc.html
+There's a part of the website that has FFmpeg documentation.
+To build it, you should have `ffmpeg` cloned to a directory:
+
+ mkdir ~/tmp
+ git clone https://git.ffmpeg.org/ffmpeg.git ~/tmp/ffmpeg
+ ./generate-doc.sh ~/tmp/ffmpeg
+
+In case of a major CSS update, please also update the `style.min.css` file in
+the main FFmpeg repo:
-[2] Install instructions, 2 methods:
+ cp htdocs/css/{bootstrap.min.css,style.min.css} ~/tmp/ffmpeg/doc/
-- Install everything globally (root required)
- - Install npm from the packages or the sources: http://nodejs.org/
- - Install lessc and bower using npm:
- $ sudo npm install -g bower less clean-css
+PUBLISH
+-------
-- Install only npm globally
- - Install npm from the packages or the sources: http://nodejs.org/
- - Install lessc and bower in the current directory using npm:
- $ npm install bower less clean-css
- - Add the path to your environment:
- $ export PATH=`pwd`/node_modules/bower/bin:`pwd`/node_modules/less/bin:$PATH
+`htdocs` has the page that's ready to publish.
diff --git a/generate-doc.sh b/generate-doc.sh
index d8d01d3..6eea1cb 100755
--- a/generate-doc.sh
+++ b/generate-doc.sh
@@ -34,9 +34,9 @@ export FA_ICONS=true
rm -rf build-doc
mkdir build-doc && cd build-doc
-$src/configure --enable-gpl --disable-yasm || die "configure failed"
+$src/configure --enable-gpl || die "configure failed"
make doc || die "doc not made"
cp doc/*.html ../htdocs/ || die "copy failed"
cd ..
-rm -rf build-doc
\ No newline at end of file
+rm -rf build-doc
--
2.51.2
_______________________________________________
ffmpeg-devel mailing list -- ffmpeg-devel@ffmpeg.org
To unsubscribe send an email to ffmpeg-devel-leave@ffmpeg.org
prev parent reply other threads:[~2025-11-13 21:26 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-13 21:24 [FFmpeg-devel] [PATCH 0/1] fixed ffmpeg-web building instructions Adam Koszek via ffmpeg-devel
2025-11-13 21:24 ` Adam Koszek via ffmpeg-devel [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251113212503.26963-2-adam@koszek.com \
--to=ffmpeg-devel@ffmpeg.org \
--cc=adam@koszek.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
This inbox may be cloned and mirrored by anyone:
git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git
# If you have public-inbox 1.1+ installed, you may
# initialize and index your mirror using the following commands:
public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
ffmpegdev@gitmailbox.com
public-inbox-index ffmpegdev
Example config snippet for mirrors.
AGPL code for this site: git clone https://public-inbox.org/public-inbox.git