Update Readme

This commit is contained in:
Mike Nolan 2023-10-29 12:46:50 -05:00
parent 37c68b2512
commit d9f36f1928
1 changed files with 42 additions and 0 deletions

View File

@ -0,0 +1,42 @@
# SimpleNotes Client for Android
# This server is required
[Repository](https://gitlab.tesses.net/tesses50/simplenotesserver)
# To Install
[Get .NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
```bash
\# dotnet workload install android
\# dotnet worload repair
```
# To compile
```bash
$ make
```
# To just test
```bash
$ dotnet run
```
# To authenticate
Click Settings
Provide URL to Server, your username and password
and Click Save
# To Send Message
Click the Plus FAB
In the note activity the save button does not close the activity, that is not a bug that is intended (so you can keep editing)
# Will this work without internet
Yes and no
Yes if the server is on same network as the android device (and you entered the private ip)
No if otherwise
# Can I edit, view or create notes without access to server
You can't edit, view or create notes if you can't connect to the server (as there is no cache).