-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix Makefile on linux. Update README
- Loading branch information
1 parent
66a89f6
commit a8ff2e8
Showing
2 changed files
with
117 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,110 +1,112 @@ | ||
| # CargoMake by NeoSmart Technologies | ||
| # Written and maintained by Mahmoud Al-Qudsi <[email protected]> | ||
| # Released under the MIT public license | ||
| # Obtain updates from https://github.com/neosmart/CargoMake | ||
|
|
||
| COLOR ?= always # Valid COLOR options: {always, auto, never} | ||
|
|
||
| ifeq ($(OS),Windows_NT) | ||
| # For Cygwin/MsysGit Windows Compatibility. | ||
| CARGO=HOME=$(USERPROFILE) cargo --color $(COLOR) | ||
| else | ||
| # For Linux/OSX | ||
| cargo --color $(COLOR) | ||
| endif | ||
|
|
||
| GIT_BIN=git | ||
|
|
||
| PROJECT = $(shell grep '^name' odel/Cargo.toml | grep -Po '(?<=")[^"]+(?=")') | ||
| VERSION = $(shell grep '^version' odel/Cargo.toml | grep -Po '(?<=")[^"]+(?=")') | ||
|
|
||
| DISTROOT=./dist | ||
| DISTDIR = $(PROJECT)-$(VERSION) | ||
| DISTZIP=$(PROJECT)-$(VERSION)-bin.zip | ||
| SRCDISTZIP=$(PROJECT)-$(VERSION)-src.zip | ||
|
|
||
| .PHONY: all bench build release check clean doc install publish run test update | ||
|
|
||
| all: build | ||
|
|
||
| bench: ## Runs benchmark tests | ||
| @$(CARGO) bench | ||
|
|
||
| build: ## Builds the project | ||
| @$(CARGO) build | ||
|
|
||
| release: ## Builds the optimized released version of the project | ||
| @$(CARGO) build --release | ||
|
|
||
| check: build test ## Checks the project and all of its dependencies for errors. | ||
|
|
||
| clean: ## Removes all generated files | ||
| @$(CARGO) clean | ||
|
|
||
| doc: ## Generates documentation HTML for this project and all dependencies | ||
| @$(CARGO) doc | ||
|
|
||
| install: build ## Installs the project binary to the cargo bin folder | ||
| @$(CARGO) install | ||
|
|
||
| publish: ## Uploads the crate to rust package registry | ||
| @$(CARGO) publish | ||
|
|
||
| run: build ## Runs the project executable | ||
| @$(CARGO) run | ||
|
|
||
| test: build ## Runs any unit tests | ||
| @$(CARGO) test | ||
|
|
||
| clippy: build ## Runs clippy code inspector | ||
| @$(CARGO) clippy | ||
|
|
||
| update: ## Updates dependencies in the Cargo.lock file to the latest version. | ||
| @$(CARGO) update | ||
|
|
||
| expand: ## Expands all macros in the source files and prints to STDOUT | ||
| @$(CARGO) expand --color=always --theme=1337 | ||
|
|
||
| completion: release | ||
| mkdir -p target/release/completion | ||
| ./target/release/$(PROJECT).exe --shell-completion zsh > target/release/completion/zsh | ||
| ./target/release/$(PROJECT).exe --shell-completion bash > target/release/completion/bash | ||
| ./target/release/$(PROJECT).exe --shell-completion fish > target/release/completion/fish | ||
| ./target/release/$(PROJECT).exe --shell-completion powershell >target/release/completion/powershell | ||
| ./target/release/$(PROJECT).exe --shell-completion elvish > target/release/completion/elvish | ||
|
|
||
| distclean: clean ## Cleans all generated files, including distribution files | ||
| rm -rf $(DISTROOT) | ||
|
|
||
| dist: release completion ## Create a distribution package | ||
| rm -rf $(DISTROOT)/$(DISTDIR) | ||
| mkdir -p $(DISTROOT)/$(DISTDIR) | ||
| cp target/release/$(PROJECT).exe $(DISTROOT)/$(DISTDIR) | ||
| -cp *.docx $(DISTROOT)/$(DISTDIR) | ||
| cp -r target/release/completion $(DISTROOT)/$(DISTDIR) | ||
| cd $(DISTROOT) && zip -r $(DISTZIP) $(PROJECT)-$(VERSION)/ | ||
| rm -rf $(DISTROOT)/$(DISTDIR) | ||
|
|
||
| distsrc: ## Creates a zip file with source code | ||
| mkdir -p $(DISTROOT)/$(DISTDIR) | ||
| rm -f $(DISTROOT)/$(SRCDISTZIP) | ||
| $(GIT_BIN) archive --format zip --output $(DISTROOT)/$(SRCDISTZIP) HEAD | ||
|
|
||
| help: ## This help dialog. | ||
| @IFS=$$'\n' ; \ | ||
| help_lines=(`fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##/~~/'`); \ | ||
| for help_line in $${help_lines[@]}; do \ | ||
| IFS=$$'~~' ; \ | ||
| help_split=($$help_line) ; \ | ||
| IFS=$$':' ; \ | ||
| help_command_split=($${help_split[0]}) ; \ | ||
| help_command=`echo $${help_command_split[0]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \ | ||
| help_target=`echo $${help_command_split[1]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \ | ||
| help_info=`echo $${help_split[2]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \ | ||
| printf '\033[36m'; \ | ||
| printf "%-9s %s" $$help_command ; \ | ||
| printf '\033[33m'; \ | ||
| printf ": %-35s %s" $$help_target ; \ | ||
| printf '\033[0m'; \ | ||
| printf "%s\n" $$help_info; \ | ||
| done | ||
| # CargoMake by NeoSmart Technologies | ||
| # Written and maintained by Mahmoud Al-Qudsi <[email protected]> | ||
| # Released under the MIT public license | ||
| # Obtain updates from https://github.com/neosmart/CargoMake | ||
|
|
||
| COLOR ?= always # Valid COLOR options: {always, auto, never} | ||
|
|
||
| ifeq ($(OS),Windows_NT) | ||
| # For Cygwin/MsysGit Windows Compatibility. | ||
| CARGO=HOME=$(USERPROFILE) cargo --color $(COLOR) | ||
| BIN_SUFFIX=.exe | ||
| else | ||
| # For Linux/OSX | ||
| CARGO=cargo --color $(COLOR) | ||
| BIN_SUFFIX= | ||
| endif | ||
|
|
||
| GIT_BIN=git | ||
|
|
||
| PROJECT = $(shell grep '^name' odel/Cargo.toml | grep -Po '(?<=")[^"]+(?=")') | ||
| VERSION = $(shell grep '^version' odel/Cargo.toml | grep -Po '(?<=")[^"]+(?=")') | ||
|
|
||
| DISTROOT=./dist | ||
| DISTDIR = $(PROJECT)-$(VERSION) | ||
| DISTZIP=$(PROJECT)-$(VERSION)-bin.zip | ||
| SRCDISTZIP=$(PROJECT)-$(VERSION)-src.zip | ||
|
|
||
| .PHONY: all bench build release check clean doc install publish run test update | ||
|
|
||
| all: build | ||
|
|
||
| bench: ## Runs benchmark tests | ||
| @$(CARGO) bench | ||
|
|
||
| build: ## Builds the project | ||
| @$(CARGO) build | ||
|
|
||
| release: ## Builds the optimized released version of the project | ||
| @$(CARGO) build --release | ||
|
|
||
| check: build test ## Checks the project and all of its dependencies for errors. | ||
|
|
||
| clean: ## Removes all generated files | ||
| @$(CARGO) clean | ||
|
|
||
| doc: ## Generates documentation HTML for this project and all dependencies | ||
| @$(CARGO) doc | ||
|
|
||
| install: build ## Installs the project binary to the cargo bin folder | ||
| @$(CARGO) install | ||
|
|
||
| publish: ## Uploads the crate to rust package registry | ||
| @$(CARGO) publish | ||
|
|
||
| run: build ## Runs the project executable | ||
| @$(CARGO) run | ||
|
|
||
| test: build ## Runs any unit tests | ||
| @$(CARGO) test | ||
|
|
||
| clippy: build ## Runs clippy code inspector | ||
| @$(CARGO) clippy | ||
|
|
||
| update: ## Updates dependencies in the Cargo.lock file to the latest version. | ||
| @$(CARGO) update | ||
|
|
||
| expand: ## Expands all macros in the source files and prints to STDOUT | ||
| @$(CARGO) expand --color=always --theme=1337 | ||
|
|
||
| completion: release | ||
| mkdir -p target/release/completion | ||
| ./target/release/$(PROJECT)$(BIN_SUFFIX) --shell-completion zsh > target/release/completion/zsh | ||
| ./target/release/$(PROJECT)$(BIN_SUFFIX) --shell-completion bash > target/release/completion/bash | ||
| ./target/release/$(PROJECT)$(BIN_SUFFIX) --shell-completion fish > target/release/completion/fish | ||
| ./target/release/$(PROJECT)$(BIN_SUFFIX) --shell-completion powershell >target/release/completion/powershell | ||
| ./target/release/$(PROJECT)$(BIN_SUFFIX) --shell-completion elvish > target/release/completion/elvish | ||
|
|
||
| distclean: clean ## Cleans all generated files, including distribution files | ||
| rm -rf $(DISTROOT) | ||
|
|
||
| dist: release completion ## Create a distribution package | ||
| rm -rf $(DISTROOT)/$(DISTDIR) | ||
| mkdir -p $(DISTROOT)/$(DISTDIR) | ||
| cp target/release/$(PROJECT)$(BIN_SUFFIX) $(DISTROOT)/$(DISTDIR) | ||
| -cp *.docx $(DISTROOT)/$(DISTDIR) | ||
| cp -r target/release/completion $(DISTROOT)/$(DISTDIR) | ||
| cd $(DISTROOT) && zip -r $(DISTZIP) $(PROJECT)-$(VERSION)/ | ||
| rm -rf $(DISTROOT)/$(DISTDIR) | ||
|
|
||
| distsrc: ## Creates a zip file with source code | ||
| mkdir -p $(DISTROOT)/$(DISTDIR) | ||
| rm -f $(DISTROOT)/$(SRCDISTZIP) | ||
| $(GIT_BIN) archive --format zip --output $(DISTROOT)/$(SRCDISTZIP) HEAD | ||
|
|
||
| help: ## This help dialog. | ||
| @IFS=$$'\n' ; \ | ||
| help_lines=(`fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##/~~/'`); \ | ||
| for help_line in $${help_lines[@]}; do \ | ||
| IFS=$$'~~' ; \ | ||
| help_split=($$help_line) ; \ | ||
| IFS=$$':' ; \ | ||
| help_command_split=($${help_split[0]}) ; \ | ||
| help_command=`echo $${help_command_split[0]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \ | ||
| help_target=`echo $${help_command_split[1]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \ | ||
| help_info=`echo $${help_split[2]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \ | ||
| printf '\033[36m'; \ | ||
| printf "%-9s %s" $$help_command ; \ | ||
| printf '\033[33m'; \ | ||
| printf ": %-35s %s" $$help_target ; \ | ||
| printf '\033[0m'; \ | ||
| printf "%s\n" $$help_info; \ | ||
| done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters