Skip to content

Commit

Permalink
update readme and remove gitpod
Browse files Browse the repository at this point in the history
  • Loading branch information
sergey-tihon committed Oct 5, 2024
1 parent 8c90806 commit fda0684
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Clippit [![NuGet Badge](https://buildstats.info/nuget/Clippit)](https://www.nuget.org/packages/Clippit)
# Clippit

![NuGet Version](https://img.shields.io/nuget/v/Clippit) ![NuGet Downloads](https://img.shields.io/nuget/dt/Clippit)

[![Build and Test](https://github.com/sergey-tihon/Clippit/actions/workflows/main.yml/badge.svg)](https://github.com/sergey-tihon/Clippit/actions/workflows/main.yml)

## Build Instructions

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/sergey-tihon/Clippit)

### Build

Call `.\build.cmd` on Windows or `./build.sh` on other systems.

### Update docs

- Install DocFx

- Windows : `choco install docfx -y`
- MacOS: `brew install docfx`

- Run `docfx docs/docfx.json --serve` to start local copy of site/docs.
- Run `docfx docs/docfx.json --serve` to start local copy of site/docs.

0 comments on commit fda0684

Please sign in to comment.