Skip to content

A script written in Deno using Typescript which automates the creation of high-quality README

License

Notifications You must be signed in to change notification settings

opeolluwa/readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Generate a README boilerplate for your project in 30ms!

Getting Started

To get started, clone the project and install the Deno

Prerequisites

The application only require Deno to run locally

Make sure you have it installed and set up before proceeding with the installation and usage of the application.

Installation

deno task install will install your CLI tool in $HOME/.deno/bin or a custom directory when you set the DENO_INSTALL_ROOT environment variable.

Usage

  • to run the project locally
deno task dev
  • to build the project locally run
deno task build
  • to install the binary
deno install --allow-sys --allow-read --allow-write main.ts

Support

Information on how to get help and support for the project, including contact details for your company's support team.

Documentation

Information on the software design, API documentation, etc

License

The project is distributed under GNU GENERAL PUBLIC LICENSE

About

A script written in Deno using Typescript which automates the creation of high-quality README

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published