https://github.com/kieran-ryan/leabhar-cliste

Programming practices, principles and concepts
https://github.com/kieran-ryan/leabhar-cliste

concepts practices principles

Last synced: 3 months ago
JSON representation

Programming practices, principles and concepts

• Host: GitHub
• URL: https://github.com/kieran-ryan/leabhar-cliste
• Owner: kieran-ryan
• Created: 2022-08-21T12:57:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-02-22T23:45:13.000Z (4 months ago)
• Last Synced: 2025-03-24T01:11:32.190Z (3 months ago)
• Topics: concepts, practices, principles
• Homepage: https://kieran-ryan.github.io/leabhar-cliste
• Size: 709 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Security: docs/security.md

Awesome Lists containing this project

README

        
# leabhar-cliste

![Pipeline status](https://github.com/kieran-ryan/leabhar-cliste/actions/workflows/main.yml/badge.svg)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/kieran-ryan/leabhar-cliste/main.svg)](https://results.pre-commit.ci/latest/github/kieran-ryan/leabhar-cliste/main)

![LICENSE](https://img.shields.io/badge/license-MIT-blue)

![Prettier](https://img.shields.io/badge/code%20style-prettier-deeppink)

Programming practices, principles and concepts.

[Visit the webpage](https://kieran-ryan.github.io/leabhar-cliste) - built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).

## Building the Docs

To build the site from source, clone the repo and run the following commands:

```console

pip install --requirement requirements.txt

mkdocs build

```

To serve and access the site from your browser run:

```console

mkdocs serve

```

## Contributing

Contributions to this project are most welcome. Feel free to [create an issue](https://github.com/kieran-ryan/leabhar-cliste/issues/new) or to raise a Pull Request.

It is recommended to use [Visual Studio Code](https://code.visualstudio.com) and [pre-commit](https://pre-commit.com) when working with the source code, which are pre-configured within the project.

```console

pip install --requirement requirements.txt

pre-commit install

```

## License

`leabhar-cliste` is licensed under the [MIT License](https://opensource.org/licenses/MIT).