Compare commits
4 Commits
75351ec24b
...
102e1da345
| Author | SHA1 | Date | |
|---|---|---|---|
| 102e1da345 | |||
| c1d14513c4 | |||
| e36add84ac | |||
| 78db1311b2 |
24
.gitea/workflows/documentme.yml
Normal file
24
.gitea/workflows/documentme.yml
Normal file
@@ -0,0 +1,24 @@
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
generate-docs:
|
||||
runs-on: ubuntu-latest
|
||||
name: Generate Docs
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: 10.0.x
|
||||
- name: Generate Documentation
|
||||
uses: FuLagann/csharp-docs-generator@v1.0
|
||||
with:
|
||||
build-tasks: dotnet build
|
||||
cleanup-tasks: dotnet clean
|
||||
binaries: bin/Debug/net10.0/SjkScripts.dll
|
||||
output-path: docs/api
|
||||
user-email: ronnie.kisner.jr@gmail.com
|
||||
user-name: C# Document Generator
|
||||
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