CatMD is a command-line tool that prints the file content as Markdown format.
Input:
cat README.md LICENSE
Output:
*README.md*
```md
(The content of README.md)
```
*LICENSE*
```
(The content of LICENSE)
```
To install CatMD, follow these steps:
- Clone the repository:
git clone https://github.com/pluveto/catmd.git
- Navigate to the project directory:
cd catmd
- Build the executable:
make
- Install CatMD:
make install
(INSTALL_DIR
can be specified, default is/usr/local/bin
)
CatMD can be used as follows:
catmd [options] <file ...>
Options:
-h, --help
: Output usage information-v, --version
: Output the version number
Examples:
catmd README.md
catmd file1.md file2.md
Contributions are welcome! Here's how you can contribute to the project:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -am 'feat: add some feature'
- Push the branch to your forked repository:
git push origin feature/your-feature-name
- Open a pull request.
Please ensure that your code follows the project's coding style and includes appropriate tests.
This project is licensed under the MIT License. See the LICENSE file for details.