forked from cory/tildefriends
		
	Fill in some blanks in the readme.
This commit is contained in:
		
							
								
								
									
										10
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								README.md
									
									
									
									
									
								
							@@ -1,6 +1,8 @@
 | 
			
		||||
# Tilde Friends
 | 
			
		||||
Tilde Friends is a tool for making and sharing.
 | 
			
		||||
 | 
			
		||||
A public instance lives at https://www.tildefriends.net/.
 | 
			
		||||
 | 
			
		||||
It is both a peer-to-peer social network client, participating in Secure
 | 
			
		||||
Scuttlebutt, as well as a platform for writing and running web applications.
 | 
			
		||||
 | 
			
		||||
@@ -11,6 +13,9 @@ Scuttlebutt, as well as a platform for writing and running web applications.
 | 
			
		||||
   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.
 | 
			
		||||
 | 
			
		||||
1. Requires openssl (`libssl-dev`, in debian-speak).  All other dependencies
 | 
			
		||||
   are kept up to date in the tree.
 | 
			
		||||
2. To build, run `make debug` or `make release`.  An executable will be
 | 
			
		||||
@@ -19,6 +24,7 @@ Scuttlebutt, as well as a platform for writing and running web applications.
 | 
			
		||||
   the right dependencies in the right places.  `make windebug winrelease
 | 
			
		||||
   iosdebug-ipa iosrelease-ipa release-apk`.
 | 
			
		||||
4. To build in docker, `docker build .`.
 | 
			
		||||
5. `make format` will normalize formatting to the coding standard.
 | 
			
		||||
 | 
			
		||||
## Running
 | 
			
		||||
By default, running the built `tildefriends` executable will start a web server
 | 
			
		||||
@@ -29,8 +35,8 @@ privileges.  Further administration can be done at
 | 
			
		||||
<http://localhost:12345/~core/admin/>.
 | 
			
		||||
 | 
			
		||||
## Documentation
 | 
			
		||||
There are the very beginnings of developer documentation in `apps/docs/`
 | 
			
		||||
that can be read in-place or at <http://localhost:12345/~core/docs/>.
 | 
			
		||||
Docs are a work in progress:
 | 
			
		||||
<https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
 | 
			
		||||
 | 
			
		||||
## License
 | 
			
		||||
All code unless otherwise noted in is provided under the
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user