From cc34f79b914ef67fc506f1f55bd59f5f7fa5573f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20Montan=CC=83ana?= Date: Fri, 8 Mar 2024 09:02:22 +0100 Subject: [PATCH] Update changelog and readme --- CHANGELOG.md | 10 ++++++++++ README.md | 6 +++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d3b799f..7c9dee2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [unpublished] + +### Added + +- Install command and instructions in README.md + +### Changed + +- Sample app now is a separate target in the Makefile and shows how to use the library with a sample dataset + ## [1.0.4] 2024-03-06 ### Added diff --git a/README.md b/README.md index 2dd4bb3..ee57085 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,14 @@ Bayesian Network Classifiers using libtorch from scratch +## Installation + ### Release ```bash make release make buildr +sudo make install ``` ### Debug & Tests @@ -21,8 +24,9 @@ make coverage ### Sample app +After building and installing the release version, you can run the sample app with the following commands: + ```bash -make release make sample make sample fname=tests/data/glass.arff ```