From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.ffmpeg.org (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTPS id C74C34D229 for ; Thu, 13 Nov 2025 21:26:37 +0000 (UTC) Authentication-Results: ffbox; dkim=fail (body hash mismatch (got b'amEZWGd5ppWK4n0ZYO0Q9CTh+JJdKzCtFAK7URkaFM0=', expected b'Bfo+3Vwz5LUbpfROY/4yHXtiBuR4/6nrCTpYqYkX9tE=')) header.d=koszek.com header.i=adam@koszek.com header.a=rsa-sha256 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ffmpeg.org; i=@ffmpeg.org; q=dns/txt; s=mail; t=1763069181; h=to : date : message-id : in-reply-to : references : mime-version : reply-to : subject : list-id : list-archive : list-archive : list-help : list-owner : list-post : list-subscribe : list-unsubscribe : from : cc : content-type : content-transfer-encoding : from; bh=64ac2Di+P+WqG59jiZ+kSJsFnPqhFke3kZcnB7wwN3U=; b=2tQ7dG/ddLjmZ5Cx4QLaVYb3ApPs2FAgW6QFX+yVaw/Wk52gpDNrElw1ycQQ0T4qyKmQu 2P9OD9A5XeTXL5V4IUomadZ2PAe7bgmTgC+3sRvzUSn979IPJZlNPmCoZtqPvHJyyuuCtBA aeUXMUJUg7NS3K7+KpcMbWaeP37TbIxJiI3RgFnrgPX5aKlg3LqkaTswV33QsxkiUH4XntZ ee/tkgJpsT5DnSQqEpE9xiqDKtPQaGmbqpLgfmdteo5M2oDw7Oh6DOdKKKIbT/dNwAU8H1y ZF6rt87hzzyOQ6jLW6wNpSnUiRypUbmcrSZNHPJ/2HlPzcEq7sMPV6Wia2ZQ== Received: from [172.19.0.2] (unknown [172.19.0.2]) by ffbox0-bg.ffmpeg.org (Postfix) with ESMTP id D8ED768FE11; Thu, 13 Nov 2025 23:26:21 +0200 (EET) ARC-Seal: i=2; cv=pass; a=rsa-sha256; d=ffmpeg.org; s=arc; t=1763069158; b=izufpdaHDCkEdg/d3Ay4bE4yZraoh/4N0+GaMepqzMoVwqm2tgHxFMNxm8iugCNO/yIXu +k5umxXA65/qxiS8Zv4dMU0y3n7jbMhGHkhGBetVVsmAwjwDPn35BEvNKOxoYRMaedSetMD 8yikCCea62cTSmEzmapQsBXCVf2wIoFUwudsF7rFN/BtCbfQSyEpsTUn7BFNKJSMIKuz0m8 Q6XTvbJh7kQeCR27Qn6kFcjtNs6a3ighoHE+iV4VoKf/RhW0DlCD8fg267GMjEjBWs8ix+1 5QKtVLmbmWPF/mal0wd1iwZl9SAcnUrmjdzFVKN7jEigHvn4HozTjqaIcuTg== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=ffmpeg.org; s=arc; t=1763069158; h=from : sender : reply-to : subject : date : message-id : to : cc : mime-version : content-type : content-transfer-encoding : content-id : content-description : resent-date : resent-from : resent-sender : resent-to : resent-cc : resent-message-id : in-reply-to : references : list-id : list-help : list-unsubscribe : list-subscribe : list-post : list-owner : list-archive; bh=amEZWGd5ppWK4n0ZYO0Q9CTh+JJdKzCtFAK7URkaFM0=; b=Gpp2bUBVWnbbGtc3gkERa2N95AcxOiaezKZNp8xjzRY7MRWkjylOi6/iBfe1d8NIP/f7Q Tih4Z4eYP0V0U/EdTQc/uEyGiWFwniLG7lWO4pAtsx6PIRKzWsJUyRY6/nVPUmOnyRrWqOS bfYJTXFaXhjCxgdq+QgkA/gCtB299uoYxhZU/8rEhPWWK0hAOfbHP0CFpuUEW3Fpc4Xq6Bl GsoWQfewNwbKfPxCI2X/c6ZLLKxEdpobnTSDj387cZ+g2bdGg0QFfq3Zg7HxIt08UggA2ym jcmBpW8YKupFIj70qHsl+pYy63nhZHIHve3J129Z4V8CtHIz57pYK61R6uyA== ARC-Authentication-Results: i=2; ffmpeg.org; dkim=pass header.d=koszek.com header.i=adam@koszek.com; arc=pass; dmarc=none Authentication-Results: ffmpeg.org; dkim=pass header.d=koszek.com header.i=adam@koszek.com; arc=pass; dmarc=none Received: from sender4-of-o51.zoho.com (sender4-of-o51.zoho.com [136.143.188.51]) by ffbox0-bg.ffmpeg.org (Postfix) with ESMTPS id 7F7A268FDA4 for ; Thu, 13 Nov 2025 23:25:44 +0200 (EET) ARC-Seal: i=1; a=rsa-sha256; t=1763069133; cv=none; d=zohomail.com; s=zohoarc; b=QQYGSLJsDMWF0jl/hxiZtlvITikCmPfThitbDvO8Ealk/1xKD9ZEaFd2CpLlxWCoRdG7mJjZn9M1l/ubYTIU/mBoWSPRYltUjzPnanCQBNFNISoLigZsC6IeO1w3Hu09T36d/9H7MEyjso+t/PcjHHtk3lYMk//CkGSwB5WQ690= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1763069133; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=Bfo+3Vwz5LUbpfROY/4yHXtiBuR4/6nrCTpYqYkX9tE=; b=PN8Ezv+Jyp++O6NaCSXHHNOLxM9DXESb4m1uslqS1OueoGwFV+693zmeDn6WN8l5PyGRo4Eb0MSjeZ2M3Dri+IZyQwbHmTAK3mgz4j9BkSwrPFKk7KzXdA0X+yt5DaXBxBW65UyNzGBM01ZfhIYv3plEXQHQpWl+5JMv/xYNquo= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=koszek.com; spf=pass smtp.mailfrom=adam@koszek.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1763069132; s=koszek; d=koszek.com; i=adam@koszek.com; h=From:From:To:To:Cc:Cc:Subject:Subject:Date:Date:Message-ID:In-Reply-To:References:MIME-Version:Content-Transfer-Encoding:Message-Id:Reply-To; bh=Bfo+3Vwz5LUbpfROY/4yHXtiBuR4/6nrCTpYqYkX9tE=; b=hrU3pVFBoKozN0DLtkNSPp+3s0eXVB37o56F4z9k8LBDaHgfDodXstce9J50JOJJ VCSbxFHpC1tn5oPnFZH9CWCVWTByoB48x/5YAmKljCtmVSUWTjnCeDsOFQi001f4ril QeTiLGzhcAdSLmyWBIffr7qhZgZj25EhiPMExgRo= Received: by mx.zohomail.com with SMTPS id 1763069129797649.4100634006525; Thu, 13 Nov 2025 13:25:29 -0800 (PST) To: ffmpeg-devel@ffmpeg.org Date: Thu, 13 Nov 2025 13:24:53 -0800 Message-ID: <20251113212503.26963-2-adam@koszek.com> X-Mailer: git-send-email 2.51.2 In-Reply-To: <20251113212503.26963-1-adam@koszek.com> References: <20251113212503.26963-1-adam@koszek.com> MIME-Version: 1.0 X-ZohoMailClient: External Message-ID-Hash: O4IBVMCVPCFQG6XVXVAI3YA757WYM2JF X-Message-ID-Hash: O4IBVMCVPCFQG6XVXVAI3YA757WYM2JF X-MailFrom: SRS0=ZrVW=5V=koszek.com=adam@ffmpeg.org X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-ffmpeg-devel.ffmpeg.org-0; header-match-ffmpeg-devel.ffmpeg.org-1; header-match-ffmpeg-devel.ffmpeg.org-2; header-match-ffmpeg-devel.ffmpeg.org-3; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list Reply-To: FFmpeg development discussions and patches Subject: [FFmpeg-devel] [PATCH 1/1] Fix the built instruction. List-Id: FFmpeg development discussions and patches Archived-At: Archived-At: List-Archive: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Adam Koszek via ffmpeg-devel Cc: Adam Koszek Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Archived-At: List-Archive: List-Post: --- 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 `. + 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