---
title: Readme for Lecture Notes for CSCI 3410 -- Database Systems
---

Here are the lecture notes, code, exercises and problems for a lecture on database taught at [Augusta University](https://www.augusta.edu/) by C. Aubert.
The webpage for this project is at <http://spots.augusta.edu/caubert/db/ln/>, and it contains a compiled version of the notes.

## Getting Started

The source code, hosted at <https://rocketgit.com/user/caubert/CSCI_3410>, is organized as follows:

~~~{.plain}
.
├── notes/
│   ├── bib/                -- References.
│   ├── code/               -- Source code included in the document.
│   ├── fig/                -- Source code for various figures used in the document. 
│   ├── img/                -- Various image files integrated in the document.
│   ├── latex/              -- Latex configuration file.
│   ├── style/              -- css style used for the web page.
│   ├── lectures_notes.md   -- The main file for the lecture notes.
│   ├── Makefile            -- Directives to generate the lecture notes.
│   └── temp.md             -- Temporary file, for debugging purposes
├── CONTRIB.md              -- A guide on how to contribute
├── KNOWN_BUGS.md           -- A list of possible bugs, improvments, things to check, ...
├── LICENSE.md              -- The licence of those notes.
└── README.md               -- The present file
~~~

Before compiling this document, you will need to install

- git (cf. <https://git-scm.com/>)
- LaTeX (cf. <https://www.latex-project.org/get/>, <https://tex.stackexchange.com/q/1092>)
- pandoc (cf. <http://pandoc.org/installing.html>)
- pandoc-numbering (cf. <https://github.com/chdemko/pandoc-numbering#installation>)
- pandoc-include-code (cf. <https://github.com/owickstrom/pandoc-include-code>)
- latexmk (cf. <https://ctan.org/pkg/latexmk/>, but it is possible that it is already part of your LaTeX installation.)
- pdf2svg (cf. <https://github.com/dawbarton/pdf2svg>)

To clone the source, use

~~~{.bash}
git clone https://rocketgit.com/user/caubert/CSCI_3410
~~~

To compile this document, simply change directory to `notes` and run

- `make fig`, then `make pdf`, to obtain the pdf version,
- `make fig_svg`, then `make html` to obtain the html version,
- `make fig_svg`, then `make odt` to obtain the odt version.

The Makefile in the `notes` folder is commented.

## Contributing

The simplest way to contribute is to report typos, errors or misleading statements.

- You can submit bug reports at <https://rocketgit.com/user/caubert/CSCI_3410/bug> (requires an account).
- You can contact or visit me, cf. <http://spots.augusta.edu/caubert/#contact>.

Refer to `CONTRIB.md` for more information.

## Authors

- **Clément Aubert** - *Initial work* - <http://spots.augusta.edu/caubert/>

See also the list of contributors who participated in this project (to come).

## License

This project is licensed under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) licence: you are free to share and adapt this document, as long as you give proper credit.
Refer to `LICENSE.md` for the complete licence.