Compare commits
7 Commits
hotfix/che
...
4543048f36
| Author | SHA1 | Date | |
|---|---|---|---|
| 4543048f36 | |||
| 38565b7c42 | |||
| 102e1da345 | |||
| c1d14513c4 | |||
| e36add84ac | |||
| 75351ec24b | |||
| 78db1311b2 |
33
.gitea/workflows/documentme.yml
Normal file
33
.gitea/workflows/documentme.yml
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
name: Generate Docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ master ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
docs:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: actions/setup-dotnet@v4
|
||||||
|
with:
|
||||||
|
dotnet-version: 10.0.x
|
||||||
|
|
||||||
|
- name: Install DocFX
|
||||||
|
run: dotnet tool install -g docfx
|
||||||
|
|
||||||
|
- name: Build Project
|
||||||
|
run: dotnet build -c Release
|
||||||
|
|
||||||
|
- name: Generate Docs
|
||||||
|
run: |
|
||||||
|
docfx init -q
|
||||||
|
docfx docfx.json
|
||||||
|
|
||||||
|
- name: Upload Docs
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: docs
|
||||||
|
path: _site
|
||||||
62
README.md
62
README.md
@@ -0,0 +1,62 @@
|
|||||||
|
# Project Title
|
||||||
|
|
||||||
|
Simple overview of use/purpose.
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
An in-depth paragraph about your project and overview of use.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
* Describe any prerequisites, libraries, OS version, etc., needed before installing program.
|
||||||
|
* ex. Windows 10
|
||||||
|
|
||||||
|
### Installing
|
||||||
|
|
||||||
|
* How/where to download your program
|
||||||
|
* Any modifications needed to be made to files/folders
|
||||||
|
|
||||||
|
### Executing program
|
||||||
|
|
||||||
|
* How to run the program
|
||||||
|
* Step-by-step bullets
|
||||||
|
```
|
||||||
|
code blocks for commands
|
||||||
|
```
|
||||||
|
|
||||||
|
## Help
|
||||||
|
|
||||||
|
Any advise for common problems or issues.
|
||||||
|
```
|
||||||
|
command to run if program contains helper info
|
||||||
|
```
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
|
||||||
|
Contributors names and contact info
|
||||||
|
|
||||||
|
ex. Dominique Pizzie
|
||||||
|
ex. [@DomPizzie](https://twitter.com/dompizzie)
|
||||||
|
|
||||||
|
## Version History
|
||||||
|
|
||||||
|
* 0.2
|
||||||
|
* Various bug fixes and optimizations
|
||||||
|
* See [commit change]() or See [release history]()
|
||||||
|
* 0.1
|
||||||
|
* Initial Release
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details
|
||||||
|
|
||||||
|
## Acknowledgments
|
||||||
|
|
||||||
|
Inspiration, code snippets, etc.
|
||||||
|
* [awesome-readme](https://github.com/matiassingers/awesome-readme)
|
||||||
|
* [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
|
||||||
|
* [dbader](https://github.com/dbader/readme-template)
|
||||||
|
* [zenorocha](https://gist.github.com/zenorocha/4526327)
|
||||||
|
* [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)
|
||||||
Reference in New Issue
Block a user