updated readme
This commit is contained in:
parent
70fa17a3b5
commit
318b909a62
28
README.md
28
README.md
@ -1,2 +1,28 @@
|
||||
# DeskHubSharp
|
||||
A desktop application that shows repos and user data from GitHub
|
||||
A desktop application that shows repos and user data from GitHub.
|
||||
|
||||
## Overview
|
||||
Please note this application only works on Windows. Mono and Wine, I did not test. Future versions of this project
|
||||
will include platform-agnostic capablities, so it is being worked on.
|
||||
|
||||
Things you can do with application is search GitHub users, look at repositories from a 10k foot view, go into to detail
|
||||
with a certain repository and clone a branch of that repository.
|
||||
|
||||
## Installation
|
||||
|
||||
This will be a standalone application in the future. For now, you will have to build this. Go into Visual Studio with
|
||||
the .NET Framework 4.6.1 or greater installed and click Start. This will build the applcaition and run this in debug mode.
|
||||
|
||||
That should be it.
|
||||
|
||||
## Running
|
||||
|
||||
Look at installation for details.
|
||||
|
||||
## Contributions
|
||||
|
||||
I don't know, I have to figure this out later.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Found a bug? You want a new feature in the program? Use the feedback form in the application or (email)[mailto:wjmiller2016@gmail.com] me!
|
||||
|
Reference in New Issue
Block a user