diff --git a/.bzrignore b/.bzrignore index 378eac2..f1e6669 100644 --- a/.bzrignore +++ b/.bzrignore @@ -1 +1,2 @@ build +.directory diff --git a/user-guide/source/conf.py b/user-guide/source/conf.py index 0d36338..da73df7 100644 --- a/user-guide/source/conf.py +++ b/user-guide/source/conf.py @@ -257,7 +257,7 @@ texinfo_documents = [ # regardless of the global pdf_compressed setting. pdf_documents = [ - ('index', u'OpenLP', u'OpenLP User Guide', u'OpenLP Team'), + ('index', u'OpenLP-User-Guide', u'OpenLP User Guide', u'OpenLP Team'), ] # A comma-separated list of custom stylesheets. Example: diff --git a/user-guide/source/getting-started.rst b/user-guide/source/getting-started/index.rst similarity index 73% rename from user-guide/source/getting-started.rst rename to user-guide/source/getting-started/index.rst index c793540..576a8fe 100644 --- a/user-guide/source/getting-started.rst +++ b/user-guide/source/getting-started/index.rst @@ -2,23 +2,20 @@ Getting Started =============== -In this section we'll be taking you through the first steps to getting OpenLP up and running on your computer. +In this section we'll be taking you through the first steps to getting OpenLP +up and running on your computer. Downloading & Installing ------------------------ -So, you've come to the side, and you want to get this awesome software. How do you do it? +Follow the instructions below to download and install OpenLP on your operating +system. -Windows -******* -Download the Windows Installer. Run it. +.. toctree:: + windows + mac-os-x + ubuntu + :maxdepth: 2 -Mac OS X -******** -Download the Mac OS X disk image. Mount it. Copy OpenLP into your Applications folder. - -Ubuntu -****** -Open your package manager. Search for OpenLP. Click Install. Fedora ****** diff --git a/user-guide/source/getting-started/mac-os-x.rst b/user-guide/source/getting-started/mac-os-x.rst new file mode 100644 index 0000000..9752687 --- /dev/null +++ b/user-guide/source/getting-started/mac-os-x.rst @@ -0,0 +1,16 @@ +.. _install-mac-os-x: + +Mac OS X +======== +Installation of OpenLP on Mac OS X is just like most other software packages +on OS X, where you simply have to drag and drop OpenLP into your Applications +directory to install it.. + +Visit the `download page `_ on the +`OpenLP website `_ to download the OpenLP disk image. + +Before the setup wizard starts, you are asked to select a langage. This is not +the language you will be using OpenLP in, it is simply the language you will +be using to install OpenLP. + +.. image:: ../screenshots/install/macosx/1-copy-to-applications.png diff --git a/user-guide/source/getting-started/ubuntu.rst b/user-guide/source/getting-started/ubuntu.rst new file mode 100644 index 0000000..e6111fb --- /dev/null +++ b/user-guide/source/getting-started/ubuntu.rst @@ -0,0 +1,52 @@ +.. _ubuntu: + +Ubuntu +====== +The latest versions of Ubuntu already have OpenLP, you simply need to open +the Software Center, search for OpenLP and click to install it. + +Open up *Software Center* by clicking on the :guilabel:`Software Center` icon +in the Launcher if you are using the *Unity* desktop, or if you are using an +older version of Ubuntu or the *Classic* desktop go to +:menuselection:`Applications` and select the *Software Center* from the bottom +of the menu. You will need to be the administrator of the system to install +OpenLP and may be asked for the administrator password several times through +this process. + +When you have the Software Center running simply search for OpenLP and click +:guilabel:`Install`. + +.. image:: ../screenshots/install/ubuntu/1-search-openlp.png + +You will see the install progress as OpenLP and the dependencies required for +it to run are downloaded. + +.. image:: ../screenshots/install/ubuntu/2-install-progress.png + +After installation you should see that OpenLP is installed. + +.. image:: ../screenshots/install/ubuntu/3-install-complete.png + +You can now run OpenLP by either searching for it in the *Dash*, or clicking on +the category *Media Apps* in Unity. If you are running the Classic Desktop you +will have OpenLP available by clicking +:menuselection:`Applications --> Sound and Video --> OpenLP` + +Ubuntu 12.04 +------------ +If you're using Ubuntu 12.04, you may need to enable the *Backports* +repository in order to find OpenLP. The *Backports* repository is a collection +of newer versions of software already available in Ubuntu. + +With *Software Center* openlp, go to :menuselection:`Edit --> Software Sources` + +.. image:: ../screenshots/install/ubuntu/4-software-sources.png + +Then click on the :guilabel:`Updates` tab and make sure the checkbox next to +:guilabel:`Backports` is checked. Click OK and then close and open *Software +Center* to refresh the software list. + +Other Ubuntu Releases +--------------------- +For information on how to install OpenLP in older Ubuntu releases, and in +Ubuntu derivatives like Kubuntu and Xubuntu, please see the Reference Manual. diff --git a/user-guide/source/getting-started/windows.rst b/user-guide/source/getting-started/windows.rst new file mode 100644 index 0000000..6e3cfcb --- /dev/null +++ b/user-guide/source/getting-started/windows.rst @@ -0,0 +1,63 @@ +.. _install-windows: + +Windows +======= +Installation of OpenLP on Windows is much like most other software packages on +Windows, where a setup wizard guides you through the process. + +Visit the `download page `_ on the +`OpenLP website `_ to download OpenLP. When you download +OpenLP on Windows, Windows will ask you if you are sure you want to download +it. Be assured that our installer is safe, and has been tested by multiple +independent vendors who have certified our installer to be free of viruses and +malware. + +.. image:: ../screenshots/install/windows/1-download.png + +Before the setup wizard starts, you are asked to select a langage. This is not +the language you will be using OpenLP in, it is simply the language you will +be using to install OpenLP. + +.. image:: ../screenshots/install/windows/2-select-language.png + +After selecting your language, the welcome screen appears. + +.. image:: ../screenshots/install/windows/3-welcome.png + +Next you be asked to accept the license. This license is the reason why OpenLP +is free. To find out more about the license, please see the +`quick guide to the GPL `_ +on the `Free Software Foundation `_'s site. + +.. image:: ../screenshots/install/windows/4-license.png + +Once you've agreed to the license, you can choose where to install OpenLP to. +This usually defaults to the best place, and it is recommended you leave it +as it is. + +.. image:: ../screenshots/install/windows/5-install-location.png + +In the next step you can select the name of the folder in your start menu +where OpenLP will put its links. + +.. image:: ../screenshots/install/windows/6-start-menu.png + +If you want the installer to put an icon on your desktop, you can do that by +checking the checkbox on the "Additional tasks" screen of the installer. + +.. image:: ../screenshots/install/windows/7-additional-tasks.png + +When the installer is ready to install OpenLP, it will show you a summary of +all the options you have selected. Click the Next button to install OpenLP. + +.. image:: ../screenshots/install/windows/8-summary.png + +The installer usually takes about a minute to install OpenLP. While it does so +it will show you the progress. + +.. image:: ../screenshots/install/windows/9-progress.png + +Lastly, once the installation is complete, you can check the "Launch OpenLP" +checkbox to run OpenLP once the installer has exited. + +.. image:: ../screenshots/install/windows/10-complete.png diff --git a/user-guide/source/index.rst b/user-guide/source/index.rst index 523855a..54aaef2 100644 --- a/user-guide/source/index.rst +++ b/user-guide/source/index.rst @@ -9,10 +9,10 @@ Welcome to the OpenLP 2.0 User Guide Contents: .. toctree:: - getting-started - adding-content - getting-more - :maxdepth: 2 + getting-started/index + adding-content + getting-more + :maxdepth: 2 Indices and tables diff --git a/user-guide/source/screenshots/install/macosx/1-copy-to-applications.png b/user-guide/source/screenshots/install/macosx/1-copy-to-applications.png new file mode 100644 index 0000000..ea460b3 Binary files /dev/null and b/user-guide/source/screenshots/install/macosx/1-copy-to-applications.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/1-search-openlp.png b/user-guide/source/screenshots/install/ubuntu/1-search-openlp.png new file mode 100644 index 0000000..61798d8 Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/1-search-openlp.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/2-install-progress.png b/user-guide/source/screenshots/install/ubuntu/2-install-progress.png new file mode 100644 index 0000000..6fd0dcb Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/2-install-progress.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/3-install-complete.png b/user-guide/source/screenshots/install/ubuntu/3-install-complete.png new file mode 100644 index 0000000..ad442e5 Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/3-install-complete.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/4-software-sources.png b/user-guide/source/screenshots/install/ubuntu/4-software-sources.png new file mode 100644 index 0000000..26f5c47 Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/4-software-sources.png differ diff --git a/user-guide/source/screenshots/install/windows/.directory b/user-guide/source/screenshots/install/windows/.directory new file mode 100644 index 0000000..e054dfd --- /dev/null +++ b/user-guide/source/screenshots/install/windows/.directory @@ -0,0 +1,3 @@ +[Dolphin] +PreviewsShown=true +Timestamp=2012,7,7,20,13,37 diff --git a/user-guide/source/screenshots/install/windows/1-download.png b/user-guide/source/screenshots/install/windows/1-download.png new file mode 100644 index 0000000..4e95c38 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/1-download.png differ diff --git a/user-guide/source/screenshots/install/windows/10-complete.png b/user-guide/source/screenshots/install/windows/10-complete.png new file mode 100644 index 0000000..86d27b3 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/10-complete.png differ diff --git a/user-guide/source/screenshots/install/windows/2-select-language.png b/user-guide/source/screenshots/install/windows/2-select-language.png new file mode 100644 index 0000000..e9014eb Binary files /dev/null and b/user-guide/source/screenshots/install/windows/2-select-language.png differ diff --git a/user-guide/source/screenshots/install/windows/3-welcome.png b/user-guide/source/screenshots/install/windows/3-welcome.png new file mode 100644 index 0000000..15a6506 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/3-welcome.png differ diff --git a/user-guide/source/screenshots/install/windows/4-license.png b/user-guide/source/screenshots/install/windows/4-license.png new file mode 100644 index 0000000..e99d938 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/4-license.png differ diff --git a/user-guide/source/screenshots/install/windows/5-install-location.png b/user-guide/source/screenshots/install/windows/5-install-location.png new file mode 100644 index 0000000..6630715 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/5-install-location.png differ diff --git a/user-guide/source/screenshots/install/windows/6-start-menu.png b/user-guide/source/screenshots/install/windows/6-start-menu.png new file mode 100644 index 0000000..ff7bc4d Binary files /dev/null and b/user-guide/source/screenshots/install/windows/6-start-menu.png differ diff --git a/user-guide/source/screenshots/install/windows/7-additional-tasks.png b/user-guide/source/screenshots/install/windows/7-additional-tasks.png new file mode 100644 index 0000000..885fc9d Binary files /dev/null and b/user-guide/source/screenshots/install/windows/7-additional-tasks.png differ diff --git a/user-guide/source/screenshots/install/windows/8-summary.png b/user-guide/source/screenshots/install/windows/8-summary.png new file mode 100644 index 0000000..6dad9f0 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/8-summary.png differ diff --git a/user-guide/source/screenshots/install/windows/9-progress.png b/user-guide/source/screenshots/install/windows/9-progress.png new file mode 100644 index 0000000..777bf37 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/9-progress.png differ