Book which will help you to learn the basic methodologies, processes and technics about the software development.
TeX Makefile
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
book
resources
.gitignore
CONTRIBUTORS
LICENSE
README.md
makefile

README.md

Software Engineering Manual

The goal is to write a book which will help you to learn the basic methodologies, processes and technics about the software development in general.

The book is actually oriented on the Java technology but nevertheless, it can be applied to any programming language.

Book is at its initial stage of writing and it is available only in a Croatian language.

How to Generate a PDF

To be able to generate a PDF yourself you have to have quite a large collection of tools. So follow the sections below to configure your environment.

Download and Install TeX Live

Go to https://www.tug.org/texlive/acquire-netinstall.html and follow directions.

Download the Source Materials

Second step is to download the source materials for the Software Engineering Manual. This can be acomplished using the Git to clone the repository or to download the source materials directly using your web browser.

If you want to use the Git than you need to have it installed on your system. So, one more tool to install. There is just one minor difference between using Git or downloading the source materials directly using your web browser. The generated PDF will lack the date and the version statement if you choose to download the source materials directly using your web browser.

Git

Go to http://git-scm.com/downloads and choose your operating system and foolow directions.

Now that you installed the Git, it is time to clone the Software Engineering Manual repository.

Open up your terminal and enter the following:

git clone https://github.com/hvarga/software-engineering-manual.git

Git will do its magic and you will have the source materials.

Web browser

If you are reluctant to install Git then point your web browser to the https://github.com/hvarga/software-engineering-manual/archive/master.zip to download the source materials.

Web browser will download the source materials contained in a ZIP archive. Extract this archive somewher on your disk.

Generate PDF

If you are using GNU/Linux, Mac OS or any UNIX then it is recommended to install make package. The installation method depends on the distribution. This means that you need to find the installation instructions for your distribution.

For CentOS, open up your terminal and type:

sudo yum install make

GNU/Linux

In the root folder of the source materials type:

make

Other

In the root folder of the source materials type:

latexmk -r book/latexmkrc -verbose -time -latexoption='-halt-on-error -synctex=1' -pdf -cd book/main.tex -jobname=build/main

Using make or latexmk directly will finally generate the PDF document. PDF will be stored in the book/build folder. Enjoy reading!

How to Contribute to the Book

Since this book is under the Creative Commons license, everyone is free to share and adapt it.

So, if you are willing to contribute by correcting grammar mistakes, making structual changes, alter the visual appereance for better readability, supplement some sections or chapters with additional informations that can help out a reader or even writing a new sections or chapters than by any means - contribute.

Learn LaTeX

This book is written using the LaTeX. So, if you want to contribute to the book than, obviously, you need to know LaTeX. Its homepage has a lot of good informations for reading. But if I have to single out just one good book to read than I would recommend "The (Not So) Short Introduction to LaTeX2e". If you don't have the time to invest in learning another technology or you are just too lazy than, please, at least read this recommended book.

Configure Environment

Now to the fun part - in order to contribute, first, follow the How to Generate a PDF section of this document. Note that if you want to contribute to the book than you need to have the Git. Without it, you cannot send me your changes that you made to the book.

After you have installed the tools described in How to Generate a PDF, it is time to install one more tool - TeXstudio.

So, head on to the http://texstudio.sourceforge.net/ and go to the "Download" section and download the TeXstudio for your platform and install it. TeXstudio is a multiplatform software and there is, actually, quite a large collection of binaries for every possible operating system.

TeXstudio is an integrated writing environment for creating LaTeX documents. If you want to contribute to the book than this is the tool to use.

Next screenshot shows the TeXstudio in action. TeXstudio main screen

After the installation of the TeXstudio, configure it according the screenshot bellow. TeXstudio configuration

Contributions to this book will be handled by the Git and the GitHub. So, create an account on the GitHub if you don't have one already. You will use Git to make versions of your changes and the GitHub pull requests to send me your changes.

Please, read a bit about the Git and the GitHub itself before you start with your contributions. Happy contributing!

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.