docs: Update some docs links to the gitea wiki and generally refresh the README.md slightly.
All checks were successful
Build Tilde Friends / Build-All (push) Successful in 16m38s

This commit is contained in:
Cory McWilliams 2024-11-26 11:42:33 -05:00
parent 2e95d6ea63
commit 595f14d98d
2 changed files with 29 additions and 16 deletions

View File

@ -14,10 +14,7 @@ Scuttlebutt, as well as a platform for writing and running web applications.
3. Make creating and sharing web applications accessible to anyone with a
browser.
## Building
Builds on Linux (x86_64 and aarch64), MacOS, OpenBSD, and Haiku. Builds for
all of those host platforms plus mingw64, iOS, and android.
## Getting the Source
Tilde Friends uses git submodules, so either:
@ -35,19 +32,35 @@ git submodule update --init --recursive
The `.tar.xz` source releases are all-inclusive.
1. On Linux only, system OpenSSL libraries (`libssl-dev`, in debian-speak) are
assumed to be available.
2. Run `make` with no arguments to see available build targets and options.
`make debug` is a good place to start.
3. It's possible to build for Android, iOS, and Windows on Linux, if you have
the right dependencies in the right places.
4. To build in docker, `docker build .`.
5. `make format` will normalize formatting to the coding standard.
## Building
Builds on Linux (x86_64 and aarch64), MacOS, OpenBSD, and Haiku. It's possible
to build for Android, iOS, and Windows on Linux, if you have the right
dependencies in the right places.
### Requirements
On Linux only, system OpenSSL libraries (`libssl-dev`, in debian-speak) are
assumed to be available.
On MacOS, Xcode's command-line tools are expected to be available.
### Build Commands
Run `make` with no arguments to see available build targets and options. `make
debug` is a good place to start.
To build in docker, `docker build .`.
`make format` and `make prettier` will normalize formatting to the coding
standard.
## Running
By default, running the built `tildefriends` executable will start a web server
at <http://localhost:12345/>. `tildefriends -h` lists further options.
By default, running the built `out/debug/tildefriends` executable will start a
web server at <http://localhost:12345/>. It expects to be run with the
repository root as the current working directory. `tildefriends -h` lists
further options.
The first user to create an account and log in will be granted administrative
privileges. Further administration can be done at
@ -56,7 +69,7 @@ privileges. Further administration can be done at
## Documentation
Docs are a work in progress:
<https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
<https://dev.tildefriends.net/cory/tildefriends/wiki>.
## License

2
docs

@ -1 +1 @@
Subproject commit 47f91bd302b68079840b6fef42add771fc3e019a
Subproject commit d14201ddcc6d0c085f1e07e3069a56143c933cc4