Download Helper Files

Shell scripts and helper files are linked as downloads throughout the developer documentation. Here is a consolidated list of these files, both as download links and as wget terminal commands.

Note

Assuming the doc- script files listed below are saved in folder ~/Projects, then the scripts may be executed from within project sub-folders with the command format ../{scriptname}. Remenber to make the scripts executable in the file permissions first.

Linux installation scripts

apt-fast.sh

For existing installs of Ubuntu (14.04 or earlier), download and install apt-fast.sh to speed up apt- installation processes. [1]

Note

The first-install.sh and rest-install.sh scripts described following are optimized using apt-fast already, so there is no need to install apt-fast separately in that case.

KUbuntu_14: apt-fast.sh

first-install.sh

After installing Ubuntu Linux (or a derivative) on your computer, download one of the following scripts as appropriate, saving it to the desktop with the name first-install.sh.

KDE-Mint_10: KDE-Mint_10.sh

KDE-Mint_12: KDE-Mint_12.sh

KUbuntu_12: KUbuntu_12.sh

KUbuntu_13: KUbuntu_13.sh

KUbuntu_14: KUbuntu_14.sh

Get the respective script from the command line via wget with:

wget -O first-install.sh http://develop.aaltsys.info/resources/_downloads/KDE-Mint_10-desktop.sh
wget -O first-install.sh http://develop.aaltsys.info/resources/_downloads/KDE-Mint_12-desktop.sh
wget -O first-install.sh http://develop.aaltsys.info/resources/_downloads/KUbuntu_12-desktop.sh
wget -O first-install.sh http://develop.aaltsys.info/resources/_downloads/KUbuntu_13-desktop.sh
wget -O first-install.sh http://develop.aaltsys.info/resources/_downloads/KUbuntu_14-desktop.sh

Execute the script with the command:

bash first-install.sh

rest-install.sh

To install ReSructuredText project support, download the script rest-install.sh to the desktop and execute it with the command,

bash rest-install.sh

The wget download command to get this script is:

wget -O rest-install.sh http://develop.aaltsys.info/resources/_downloads/rest-install.sh

RST project command links

doc-newproject.sh

Start a new documentation project in your ~/Projects folder with the command ~/Projects/doc-newproject.sh {project_folder_name}.

Recommended location for script: ~/Projects/doc-newproject.sh.

Download link: doc-newproject.sh.

Get the script from the command line with

wget -O doc-newproject.sh http://develop.aaltsys.info/resources/_downloads/doc-newproject.sh

doc-addbranch.sh

Add documentation into an existing development project with the command ~/Projects/doc-addbranch.sh {project_folder_name}.

Recommended location for script: ~/Projects/doc-addbranch.sh.

Download link: doc-addbranch.sh.

Get the script from the command line with

wget -O doc-addbranch.sh http://develop.aaltsys.info/resources/_downloads/doc-addbranch.sh

doc-deploy.sh

Deploy a documentation project to either Github gh-pages or Heroku with the command ~/Projects/doc-deploy.sh {project_folder_name}

Recommended location for script: ~/Projects/doc-deploy.sh.

Download link: doc-deploy.sh

Get the script from the command line with

wget -O doc-deploy.sh http://develop.aaltsys.info/resources/_downloads/doc-deploy.sh

aaltsys theme documents

doc-...sh scripts include custom stylesheet CSS in your documentation project. Add these default theme files with the commands:

mkdir -p _static/aaltsys
wget -O _static/aaltsys.css_t http://develop.aaltsys.info/resources/_downloads/aaltsys.css_t
wget -O _static/aaltsys/theme.conf http://develop.aaltsys.info/resources/_downloads/aaltsys/theme.conf

.gitignore

Add the following .gitignore file to a documentation project to avoid undesirable chuff in the repository.

Recommended file location: ~Projects/documentation_folder_name/.gitignore.

Download link: gitignore.

Get this file from the command line with

wget -O .gitignore http://develop.aaltsys.info/resources/_downloads/.gitignore

.htaccess

To add basic authentication to a pseudo-static documentation project deployed on Heroku, add the following .htaccess server directive file:

Recommended location: ~/Projects/documentation_folder_name/_static/.htaccess.

Download link: htaccess.

Get this file from the command line with

wget -O _static/.htaccess http://develop.aaltsys.info/resources/_downloads/.htaccess

Note

An .htpasswd file is also required, in the same directory. Learn about basic authentication using .htaccess at .htaccess Tools.

—

Footnotes

[1]	Dan Nanni, Xmodulo, shows us how to speed up apt-get.