Skip to content

Added Usage for Windows section #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v3
Choose a base branch
from
Open

Added Usage for Windows section #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/uninstall.sh -o un
```

#### Windows
**For windows download the binary and set environment variable so that you can access the binary from terminal**
**For windows download the binary to set environment variable so that you can access the binary from terminal**

#### Binary link
[Download binary](https://github.com/thedevsaddam/docgen/releases)
Expand All @@ -38,6 +38,12 @@ curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/uninstall.sh -o un
* To make HTML documentation use `docgen build -i input-postman-collection.json -o ~/Downloads/index.html`
* To make Markdown documentation use `docgen build -i input-postman-collection.json -o ~/Downloads/index.md -m`

### Usage for Windows
* After you have downloaded the binary, `windows_amd64.exe`, copy it and paste it in the same folder as your `input-postman-collection.json`.
* Open terminal in that folder and use `windows_64 build -i input-postman-collection.json -o ./index.html`
* Notice that in previous command we used `windows_64 build -i`. If we rename the binary that we downloaded to `docgen`, we can use the previous commands in above `Usage` section.
* After changing the binary name, the build command now is `docgen build -i input-postman-collection.json -o ./index.html`

***[Demo markdown API documentation](_examples/example-doc.md)***

### Contributor
Expand Down