Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/golangid/anoman
Very simple README generator for your repository
https://github.com/golangid/anoman
cli go golang markdown markdown-generator readme readme-template
Last synced: 3 months ago
JSON representation
Very simple README generator for your repository
- Host: GitHub
- URL: https://github.com/golangid/anoman
- Owner: golangid
- License: mit
- Created: 2019-02-01T03:56:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-06T10:52:51.000Z (almost 6 years ago)
- Last Synced: 2024-06-20T11:09:46.922Z (5 months ago)
- Topics: cli, go, golang, markdown, markdown-generator, readme, readme-template
- Language: Go
- Homepage:
- Size: 42 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - golangid/anoman - Very simple README generator for your repository (Go)
README
Very simple README generator for your repository
#
### Todo
- validation
### Installation
- Build from source
```shell
$ go get github.com/golangid/anoman
$ go build
$ ./anoman -v
```
- Mac OS
```shell
$ brew tap golangid/tool
$ brew install anoman
```
- Get specific release (eg: for Linux)
```shell
$ wget https://github.com/golangid/anoman/releases/download/v0.0.0/anoman-v0.0.0.linux-amd64.tar.gz
$ tar -zxvf anoman-v0.0.0.linux-amd64.tar.gz
$ anoman -v
```
### Usage
```shell
$ anoman -o README.md
$
$ echo just answer the given questions :)
$
$ project name ? : Anoman
$
$ website ? : www.anoman.com
$
$ project descriptions ? : README Generator for your project
$
$ notice ? : this project still in development, but ready to use
$
$ author name ? : golangid
$
$ year ? : 2019
```
#### Result
ANOMAN
www.anoman.com
### What is Anoman?
README Generator for your project
> #### Important Notice
> this project still in development, but ready to use
### Usage:
- one
- two
- three
#
### Author
**golangid 2019**
#
### Golangid 2019