Fakultas Ilmu Komputer UI

README.md 1.39 KB
Newer Older
1
# Software Quality Assurance Course Website
Daya Adianto's avatar
Daya Adianto committed
2

3
[![pipeline status](https://gitlab.cs.ui.ac.id/pmpl/course-site/badges/master/pipeline.svg)](https://gitlab.cs.ui.ac.id/pmpl/course-site/-/commits/master)
Daya Adianto's avatar
Daya Adianto committed
4

5
6
7
8
## Requirements

- Python >= 3.9
- [`pipenv`](https://pipenv.kennethreitz.org/en/latest/)
Daya Adianto's avatar
Daya Adianto committed
9
10
11
- [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
  - Included in the [list of dependencies](./Pipfile) that will be installed by
    `pipenv`
12
13
14
15

## Getting Started

Assuming `pipenv` present in the shell, create a new virtual environment and
Daya Adianto's avatar
Daya Adianto committed
16
install all of the required dependencies into the new virtual environment:
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

```shell
pipenv sync
```

Activate the virtual environment:

```shell
pipenv shell
```

To live preview the website:

```shell
mkdocs serve
```

Any new changes to the website can be previewed locally using the dev server.

To build the website:

```shell
mkdocs build
```

By default, the built website is written into `site` directory.

Daya Adianto's avatar
Daya Adianto committed
44
45
46
47
48
49
## Adding New Content

Write the new content into a new text file written using Markdown format and
store them in [`docs/`](./docs/) directory. Then, update the navigation section
(i.e., `nav`) in [`mkdocs.yml`](./mkdocs.yml).

50
51
52
53
54
55
## License

Copyright (c) 2021 Faculty of Computer Science Universitas Indonesia.

This project is licensed under the Creative Commons Attribution-ShareAlike 4.0
International (CC BY-SA 4.0).