UnifieReadme

UnifieReadme : Create a uniform README template for all projects to ensure consistency and clarity of the code base.

English | 中文

Background

The README file should tell people why the package or software is being used, how to install it, and how to use it. Unifying README files can make it easier to create and maintain README files.

Features

Harmonization : Ensure consistency and clarity of the code base.
Customizable : Users can modify and customize it according to their needs.

Install

This project uses node and npm. Go check them out if you don't have them locally installed.

$ npm install --global unifile-readme-spec

Usage

Please note that unifilereadme package only provides the function of converting txt files to markdown format, if your txt file does not meet the syntax requirements of markdown format, the converted result may have unexpected errors.

const fs = require('fs');
const unifilereadme = require('unifilereadme');

const txtFile = fs.readFileSync('file.txt', 'utf-8');
const markdown = unifilereadme(txtFile);

fs.writeFileSync('file.md', markdown);

Generator

You can also use the command line tool to generate a README.md file:

$ unifilereadme --help

  Usage
    $ unifilereadme <input> <output>

  Options
    --help, -h  Show help options
    --version, -v  Show version number

  Examples
    $ unifilereadme input.txt output.md

Where input.txt is the path of the txt file to be converted and output.md is the path of the generated markdown file. You can replace these two parameters according to the actual situation. The generated markdown file will be saved in the output.md file.

API

I/O Functions

Function	Description	Finish
create_grid	🌐 Creates a grid from geotiff.	✅
read_raster	🌏 Reads raster data from geotiff.	✅
to_raster	🗺️ Write grids to raster files (e.g. geotiff).	✅

FLOW Functions

Function	Description	Finish
water_supply	⤴️ Calculate water service supply.	❌
water_demand	⤵️ Calculate water service demand.	❌
water_direction	🏳️ Calculate the water service direction.	❌

Accumulate Functions

Function	Description	Finish
raster_flow	🚀 Calculate raster-scale water flow.	❌
watershed_flow	⭐ Calculate watershed scale water flow.	❌

View Functions:

Function	Description	Finish
view_plot	📊 Draw a water service view.	❌

Documentation

Authors

@JinghaoHu.

Contributing

Thanks to the following people who participated in the project:

Welcome to join !

Found a mistake? There is something meaningless? Send me a pull request !

License

About

A comprehensive self-reporting document creation tool that helps you create professional and informative documents for your projects.

MIT License

hujinghaoabcd / UnifieReadme