From 2e49862a7e40b87b704eaf3ef0a30b8cf483cb24 Mon Sep 17 00:00:00 2001 From: Alexandre Pasmantier Date: Sun, 10 Nov 2024 20:33:03 +0100 Subject: [PATCH] chore: update Makefile and CONTRIBUTING.md --- CONTRIBUTING.md | 8 +++++-- Makefile | 52 ++++------------------------------------- dist-scripts/install.sh | 24 ------------------- 3 files changed, 10 insertions(+), 74 deletions(-) delete mode 100644 dist-scripts/install.sh diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c73c9ce..fbbe3b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,12 +63,16 @@ configuration: To build the project in debug mode, run the following command in the project directory: ```shell -make build_debug +make +``` +or +```shell +make build ``` To build the project in release mode, run the following command in the project directory: ```shell -make build_release +make release ``` Formatting the code ```shell diff --git a/Makefile b/Makefile index 6176518..304861c 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,4 @@ -VERSION=0.3.13 -NAME=television -EXEC=tv -PREFIX=$(HOME)/.local - -default: build_release +default: build setup: @echo "Setting up $(NAME)" @@ -23,11 +18,11 @@ check: @echo "Checking $(NAME)" @cargo check -build_release: +release: @echo "Building release: $(VERSION)" @cargo build --release -build_debug: +build: @echo "Building debug" @cargo build @@ -50,43 +45,4 @@ run: test: @echo "Testing $(NAME)" - @cargo test - -install_debug: build_debug - @echo "Installing debug" - @cp target/debug/$(EXEC) $(PREFIX)/bin - -install: build_release - @echo "Installing release: $(VERSION)" - @cp target/release/$(EXEC) $(PREFIX)/bin - -dist: build_release - @if [ ! -d ./pkg ]; \ - then \ - mkdir ./pkg; \ - fi - - @if [ -d ./pkg/$(NAME)-$(VERSION) ]; \ - then \ - echo "Current version number already exists! Removing old files!"; \ - rm -rf ./pkg/$(NAME)-$(VERSION); \ - fi - - @mkdir ./pkg/$(NAME)-$(VERSION) - - @cp ./dist-scripts/install.sh ./pkg/$(NAME)-$(VERSION)/ - - @sed -i 's#{prefix}#$(PREFIX)#g' ./pkg/$(NAME)-$(VERSION)/install.sh - @sed -i 's#{version}#$(VERSION)#g' ./pkg/$(NAME)-$(VERSION)/install.sh - @sed -i 's#{name}#$(NAME)#g' ./pkg/$(NAME)-$(VERSION)/install.sh - @sed -i 's#{exec}#$(EXEC)#g' ./pkg/$(NAME)-$(VERSION)/install.sh - - @mkdir ./pkg/$(NAME)-$(VERSION)/files - @cp target/release/$(EXEC) ./pkg/$(NAME)-$(VERSION)/files/ - @strip ./pkg/$(NAME)-$(VERSION)/files/$(EXEC) - - @cp LICENSE ./pkg/$(NAME)-$(VERSION)/ - - @cd ./pkg && tar -czf ./$(NAME)-$(VERSION).tar.gz ./$(NAME)-$(VERSION) - @echo "Cleaning up" - @rm -rf ./pkg/$(NAME)-$(VERSION) + @cargo test --all diff --git a/dist-scripts/install.sh b/dist-scripts/install.sh deleted file mode 100644 index 0bedac2..0000000 --- a/dist-scripts/install.sh +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/sh -PREFIX={prefix} -VERSION={version} -NAME={name} -EXEC={exec} - -if [ $1 == "uninstall" ] -then - echo "Uninstalling $NAME" - rm -rf $PREFIX/bin/$EXEC - exit -fi - -if [ $1 == "help" ] -then - echo "\`./install.sh uninstall' to uninstall the program." - echo "\`./install.sh' or \`./install.sh install' to install the program." - echo "\`./install.sh' help to show this page." - exit -fi - -echo "Installing $NAME, version: $VERSION, into: $PREFIX/bin/$EXEC" - -cp files/$EXEC $PREFIX/bin/