cory/tildefriends
5
6
Fork 2
Code Issues 34 Pull Requests 1 Actions Releases 28 Wiki Activity

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
Details

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
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 3. Make creating and sharing web applications accessible to anyone with a
browser. browser.
## Building ## Getting the Source
Builds on Linux (x86_64 and aarch64), MacOS, OpenBSD, and Haiku. Builds for
all of those host platforms plus mingw64, iOS, and android.
Tilde Friends uses git submodules, so either: Tilde Friends uses git submodules, so either:
@ -35,19 +32,35 @@ git submodule update --init --recursive
The `.tar.xz` source releases are all-inclusive. The `.tar.xz` source releases are all-inclusive.
1. On Linux only, system OpenSSL libraries (`libssl-dev`, in debian-speak) are ## Building
assumed to be available.
2. Run `make` with no arguments to see available build targets and options. Builds on Linux (x86_64 and aarch64), MacOS, OpenBSD, and Haiku. It's possible
`make debug` is a good place to start. to build for Android, iOS, and Windows on Linux, if you have the right
3. It's possible to build for Android, iOS, and Windows on Linux, if you have dependencies in the right places.
the right dependencies in the right places.
4. To build in docker, `docker build .`. ### Requirements
5. `make format` will normalize formatting to the coding standard.
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 ## Running
By default, running the built `tildefriends` executable will start a web server By default, running the built `out/debug/tildefriends` executable will start a
at <http://localhost:12345/>. `tildefriends -h` lists further options. 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 The first user to create an account and log in will be granted administrative
privileges. Further administration can be done at privileges. Further administration can be done at
@ -56,7 +69,7 @@ privileges. Further administration can be done at
## Documentation ## Documentation
Docs are a work in progress: 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 ## License

2
docs

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