Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/colinkiama/vala-tutorial

An unofficial ✨modern✨ Vala tutorial
https://github.com/colinkiama/vala-tutorial

docs documentation examples tutorial vala

Last synced: about 2 months ago
JSON representation

An unofficial ✨modern✨ Vala tutorial

Awesome Lists containing this project

README

        

# Vala Tutorial

An unofficial modern Vala tutorial

You can view this tutorial online here: https://colinkiama.github.io/vala-tutorial

This tutorial is what I wished I had while I was learning Vala.
This should not be treated as an official tutorial at all but I hope that it's helpful to you.

## Requirements

- `sphinx >= 4.2.0`
- `furo` (Sphinx Theme)
- `sphinx-copy-button` (Sphinx Extension)
- `pygments`
- `make`

## Getting started

1. Build the website with:

```sh
make
```

or if you are using GNOME builder, you can click on the "Build" button.

2. In the `build` directory, open a html file in your favourite web browser. `index.html` contains the home page.

3. Whenever you want to rebuild the site with changes you make in `source`, repeat step 1.

## Progress

You can find the details of what's included in each chapter below in the [outline.md](./outline.md).

- [X] Introduction
- [X] Setup
- [X] Getting Started
- [X] Data Types and Control Structures
- [ ] Methods
- [ ] Collections
- [ ] Error Handling
- [ ] Object-Oriented Programming
- [ ] Libraries and Build Systems
- [ ] Debugging and Testing
- [ ] Multithreading
- [ ] D-Bus
- [ ] Memory Management
- [ ] Profiles
- [ ] Coding Styles
- [ ] Community
- [ ] Epilogue

## References

- [Sphinx Documentation](https://www.sphinx-doc.org/en/master/contents.html)
- [Furo Theme](https://github.com/pradyunsg/furo)
- [reStructuredText (The format that this tutorial is written in.)](https://www.writethedocs.org/guide/writing/reStructuredText/)
- [Google Technical Writing Resources](https://developers.google.com/tech-writing)