/README.md (89d4bbdb7d74a9155ce99620374c1235e727d948) (3348 bytes) (mode 100644) (type blob)
---
title: Readme for Lecture Notes for CSCI 3410 -- Database Systems
author: Clément Aubert
lang: en
fontsize: 10pt
documentclass: scrartcl
numbersections: true
papersize: letter
geometry: margin=1in
---
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.
Mode |
Type |
Size |
Ref |
File |
100644 |
blob |
389 |
8052619aa396d4180904e6a2dca7d10e1774e5a0 |
CONTRIB.md |
100644 |
blob |
3072 |
aa8394ece9e37fd6004b2f9f57fd4cce3db8b6e0 |
KNOWN_BUGS.md |
100644 |
blob |
17177 |
45e6f62aefef35ec4efdd5799f7116cae04ebec9 |
LICENSE.md |
100644 |
blob |
3348 |
89d4bbdb7d74a9155ce99620374c1235e727d948 |
README.md |
040000 |
tree |
- |
cdd183ef3887850e7c7552e1d9fee52bbf107984 |
notes |
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"
Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/caubert/CSCI_3410
Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/caubert/CSCI_3410
Clone this repository using git:
git clone git://git.rocketgit.com/user/caubert/CSCI_3410
You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a
merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main