A description of how to use mkdoc.

Command line tool to create a simple package for Homebrew.

How to use

Installation method

# -- Related tools and tap of mkdoc are add
# - For compiling ShellScript
brew tap mknclab/shcnv
# - A tool containing a Homebrew template group
brew tap mknclab/hbprt
# - Generation of translation file and reflection of Tag
brew tap mknclab/setpush
# - Tools to determine unused variables in ShellScript
brew tap mknclab/scc
# -- Add mkdoc
brew tap mknclab/mkdoc && brew install mkdoc

Initial setting

# This tool generates the directory structure needed for generation by initial setting.
# In addition, it has a structure that can not be generated except for the relevant directory, so there will be no generation error unless you touch the file name.
# The order of initialization / command arguments is as follows.
# mkdoc --init [ CURRENT DIR ] [ Github Name ]
Example) mkdoc --init . Github-Username

Basic function (I will explain along the procedure until git push.)

Step 1, Package generation (If you did not select sh, go to step 3)
# Please enter the following options and arguments to generate repository for package.
# Items for selecting Description or License are displayed during generation.
# When FILETYPE enters another language name, ShellScript template is not selected and only directory structure for compilation is generated.
# mkdoc --prototype [ REPOSITORY ] [ FILETYPE / sh | bash | * ]
Example) mkdoc --prototype example bash
Step 2, Generate package locale file
# Use './example-devel.sh' to generate translation file from ShellScript gettext item.
# Please input the following options and arguments to generate the locale file.
# mkdoc --translate convert [ REPOSITORY ] [ VERSION ]
Example) mkdoc --translate convert example 1.0.0
# Copy ShellScript for compilation into './_ source/example'.
# mkdoc --translate copy [ REPOSITORY ]
Example) mkdoc --translate copy example
Step 3, Generate a file for compilation.
# Please input the following option and argument for generation such as configure.ac.
# mkdoc --add [ REPOSITORY ] [ VERSION ] [ EDITOR / vim | emacs | nano | less ]
Example) mkdoc --add example 1.0.0 less
Step 4, When releasing with Github
# Enter the hash value after pushing to the remote repository.
# Please input the following option and argument to generate tag.
# mkdoc --gittags push [ REPOSITORY ] [ VERSION ] [ HASH ]
Example) mkdoc --gittags push example 1.0.0 xxxxxxx
# Remove the tag from the remote repository.
# Please enter the following option and argument to delete tag.
# mkdoc --gittags del [ REPOSITORY ] [ VERSION ]
Example) mkdoc --gittags del example 1.0.0
# Show tag list
# Enter the following options and arguments to display the tag list.
# mkdoc --gittags list [ REPOSITORY ]
Example) mkdoc --gittags list example

Other features

・Edit initialization file
# Edit the file that recorded Github user name and copyright etc. entered by default.
# mkdoc --edit [ EDITOR / vim | emacs | nano ]
Example) mkdoc --edit vim
・View initialization file
# View the file that recorded Github user name and copyright etc. entered by default.
Example) mkdoc --view
・String substitution in repository
# The copyright etc edited earlier will be reflected in the repository.
# mkdoc --change [ REPOSITORY ] [ FILETYPE / sh | bash | * ]
Example) mkdoc --change example bash
・Delete local repository
# Delete the local repository on the current directory.
# mkdoc --remove [ REPOSITORY ] [ VERSION ]
Example) mkdoc --remove example 1.0.0
・Determining unused variables (shell script only)
# In a shell script, find out which variable you are not using or deleting.
# mkdoc --check [ REPOSITORY ]
Example) mkdoc --check example

Change log

License

MIT lincense
%d人のブロガーが「いいね」をつけました。