From c7f200e9c533d10a3277292272f1d757ec602d39 Mon Sep 17 00:00:00 2001 From: Kevin Ollivier Date: Thu, 10 Aug 2006 04:05:50 +0000 Subject: [PATCH] Adding technotes about the release system and about adding apps/screenshots to the wxWidgets.org front page git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40543 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/tech/index.txt | 2 ++ docs/tech/tn0022.txt | 49 ++++++++++++++++++++++++++++++++++++++++++++ docs/tech/tn0023.txt | 35 +++++++++++++++++++++++++++++++ 3 files changed, 86 insertions(+) create mode 100644 docs/tech/tn0022.txt create mode 100644 docs/tech/tn0023.txt diff --git a/docs/tech/index.txt b/docs/tech/index.txt index 68d449be80..afdc179298 100644 --- a/docs/tech/index.txt +++ b/docs/tech/index.txt @@ -22,6 +22,8 @@ tn0018.txt How to add a new font encoding/charset to wxWidgets tn0019.txt Special notes about writing wxMSW code tn0020.txt Binary Compatability and wxWidgets tn0021.txt How to add a new wxUSE_XXX preprocessor constant +tn0022.txt Working with the the wxWidgets release system +tn0023.txt Adding a new app/screenshot to the wxWidgets.org front page Version: $Id$ diff --git a/docs/tech/tn0022.txt b/docs/tech/tn0022.txt new file mode 100644 index 0000000000..591e0c6933 --- /dev/null +++ b/docs/tech/tn0022.txt @@ -0,0 +1,49 @@ + Working with the the wxWidgets release system + ===================================== + +Currently, to generate the release tarballs, wxWidgets uses a script which +reads from a series of manifest files to determine which files should be +installed for a particular port. This document explains how to alter the list +of files that are distributed in the release tarballs. + +The scripts are located in the /distrib/scripts folder, with +create_archives.sh doing most of the work to create the actual tarballs. +pre-flight.sh runs the entire process of doing a checkout, building the releases, +and putting them into the /deliver folder. The manifest files +are located in the /distrib/scripts/manifests folder and +they have a .rsp extension for historical reasons. + + +Adding/removing a file from releases +------------------------------------ + +First, you must decide which tarballs you'd like to make the change to, in +order to determine which manifest file(s) the file should appear in. + +Below is a list of each port and the primary manifest files that are used to +generate that release. The "ALL" in the list is not for wxALL, it means that +those manifests are where things that go in all ports should be. + +tarball primary manifests +------- ---------------- +ALL generic.rsp +wxBase base.rsp +wxMSW msw.rsp, wince.rsp +wxOS2 os2.rsp +wxGTK gtk.rsp +wxMAC mac.rsp cocoa.rsp +wxMotif motif.rsp +wxMGL mgl.rsp +wxX11 x11.rsp + +Once you've decided which manifest file is most appropriate to add your file +in, then open that manifest and add a line with your file(s) at the bottom. +The file(s) should give the path relative to the wxWidgets root directory, +like so: + +docs/tech/tn0033.txt + +At the current time, wildcards in filenames are also accepted. Once the files are +added, they should show up in releases when distrib/scripts/pre-flight.sh is run. + + diff --git a/docs/tech/tn0023.txt b/docs/tech/tn0023.txt new file mode 100644 index 0000000000..b88ff13abc --- /dev/null +++ b/docs/tech/tn0023.txt @@ -0,0 +1,35 @@ + Adding a new app/screenshot to the wxWidgets.org front page + ===================================== + +To add a new app/screenshot to the front page, you first will need to have the +following: + +1. The application Name +2. A URL for the application +3. A series of screenshots for the app + +Each screenshot should have a 300 pixel width. A height around 225 pixels is +preferred, but it's more important to keep the aspect ratio of the screenshot. +Screenshot format is not important, but the important thing is to use the format +that gives you the best ratio of picture compression and size. Also, please +make sure the screenshots all have the app name in them. + +Once you have the screenshots and info ready, take the following steps to +update the web site: + +1) Put the screenshots in /site-v2/images/front_screens + +2) Open /site-v2/index.php + +3) Look for the "$apps = array();" line. Below it will be a series of items, +which are the data used for each app shown in the front page screenshots. + +Add a new line at the bottom, with the following format: + +$apps[] = array(appname, appurl, array(screenshot1, screenshot2, ...)); + +The screenshot1, etc. filenames should not have any path to them. They should +just be the filename. The actual shown screenshot is chosen at random from +the list of screenshots, so order, etc. doesn't matter. + +Once you've done this, the new app w/screenshots should appear on the front page! \ No newline at end of file -- 2.47.2