Changeset 88


Ignore:
Timestamp:
Mar 2, 2010 8:35:20 AM (11 years ago)
Author:
bradbell
Message:

[ckbs/trunk] Docuemntation is now included in the downloaded releases.

ckbs.omh: new download instructions.
new_release.sh: script for create a new release.

Location:
projects/ckbs/trunk
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • projects/ckbs/trunk/ckbs.omh

    r79 r88  
    6767$head Download$$
    6868
     69$subhead Release Tarballs$$
     70You can download a tarball release of ckbs from the directory
     71$pre
     72        $$
     73$href%http://www.coin-or.org/download/source/CoinBazaar%$$
     74$pre
     75$$
     76Theses releases are named
     77$codei%
     78        ckbs-0.%yyyymmdd%.%r%.%ext%
     79%$$
     80where $icode yyyy$$ is the year,
     81$icode mm$$ is the month,
     82$icode dd$$ is the day,
     83$icode r$$ is the release number,
     84and $icode ext$$ is $code tgz$$ or $code zip$$.
     85$pre
     86
     87$$
     88If $icode ext$$ is $code tgz$$ the command
     89$codei%
     90        tar -xvzf ckbs-0.%yyyymmdd%.%r%.tgz
     91%$$
     92will create the $codei%ckbs-0.%yyyymmdd%.%r%$$ directory.
     93$pre
     94
     95$$
     96If $icode ext$$ is $code zip$$ the command
     97$codei%
     98        unzip ckbs-0.%yyyymmdd%.%r%.zip
     99%$$
     100will create the $codei%ckbs-0.%yyyymmdd%.%r%$$ directory.
     101
    69102$subhead Using Subversion$$
    70 If you have subversion, you can download a copy of the most recent
    71 version of ckbs with the command
     103For each release listed in the
     104$href%http://www.coin-or.org/download/source/CoinBazaar%download directory%$$
     105you can use subversion to download the release with the commands
     106$codei%
     107        web="https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs"
     108        svn checkout @web/releases/0.%yyyymmdd%.%r% ckbs-0.%yyyymmdd%.%r%
     109%$$
     110This will create the $codei%ckbs-0.%yyyymmdd%.%r%$$ directory.
     111
     112$subhead Latest Version$$
     113You can download the most recent version of ckbs (called the trunk)
     114using the commands
    72115$codei%
    73116        web="https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs"
    74117        svn checkout @web/trunk ckbs-0.20100228.0
    75118%$$
    76 You can download a previous release of ckbs with the command
    77 $codei%
    78         svn checkout @web/releases/0.%yyyymmdd%.%r% ckbs-0.%yyyymmdd%.%r%
    79 %$$
    80 where $icode yyyy$$ is the year,
    81 $icode mm$$ is the month,
    82 $icode dd$$ is the day,
    83 and $icode r$$ is the release number for the release you want.
    84 In either case, this creates the directory
    85 $codei%ckbs-0.%yyyymmdd%.%r%$$.
    86 $pre
    87 
    88 $$
    89 The release number ($icode r$$ above)
    90 starts at zero and is incremented for bug fixes.
    91 The date ($icode yyyymmdd$$ above)
    92 is incremented with feature changes which are discussed by date
    93 in the $cref/whatsnew/$$ section of this documentation
    94 
    95 $subhead Release Tarballs$$
    96 If you do not have subversion you can download the tarball
    97 $codei%ckbs-0.%yyyymmdd%.%r%.tgz%$$ from the release download directory
    98 $codep
    99         http://www.coin-or.org/download/source/CoinBazaar
    100 $$
    101 You can extract the files from the tarball using the command
    102 $codei%
    103         tar -xvzf ckbs-0.%yyyymmdd%.%r%.tgz
    104 %$$
    105 This will create the directory
    106 $codei%ckbs-0.%yyyymmdd%.%r%$$.
     119This will create the $code ckbs-0.20100228.0$$ directory.
    107120
    108121$head Test Install$$
     
    115128
    116129$head Documentation$$
    117 A copy of the documentation for your version of ckbs can
    118 be built by executing the command
     130If you download a release, a copy of the documentation for the release
     131can be found be viewed in your browser by opening the file
     132$codei%
     133        ckbs-0.%yyyymmdd%.%r%/doc/ckbs.xml
     134
     135%$$
     136If you download the latest version (the trunk),
     137a copy of the documentation for this version can
     138be built by executing the commands
    119139$codep
     140        cd ckbs-0.20100228.0
    120141        ./build_doc.sh
    121142$$
    122 in the $codei%ckbs-0.%yyyymmdd%.%r%$$ directory.
    123 You can then view the documentation by loading the file
     143You can then view the documentation in your browser by opening the file
    124144$codei%
    125         ckbs-0.%yyyymmdd%.%r%/doc/ckbs.xml
     145        ckbs-0.20100228.0/doc/ckbs.xml
    126146%$$
    127 into your browser.
    128147
    129148$childtable%
Note: See TracChangeset for help on using the changeset viewer.