cory/tildefriends
4
5
Fork 1
Code Issues 31 Pull Requests 1 Actions Releases 24 Wiki Activity

Updated the readme.

Browse Source 
git-svn-id: https://www.unprompted.com/svn/projects/tildefriends/trunk@4066 ed5197a5-7fde-0310-b194-c3ffbd925b24
This commit is contained in:
Cory McWilliams 2022-12-01 01:07:06 +00:00
parent 376094452e
commit 7fe3bddeba
1 changed files with 23 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,24 +1,36 @@
# Tilde Friends # Tilde Friends
Tilde Friends is a program that aims to securely host and share pure JavaScript web applications. Tilde Friends is a tool for making and sharing.
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.
## Goals ## Goals
1. Make it easy and fun to run all sorts of web applications. 1. Make it easy and fun to run all sorts of web applications.
2. Provide a security model that is easy to understand and protects your data. 2. Provide security that is easy to understand and protects your data.
3. Make creating and sharing web applications accessible to anyone with a browser. 3. Make creating and sharing web applications accessible to anyone with a
browser.
## Building ## Building
1. Requires openssl. Other dependencies are kept up to date in the tree. 1. Requires openssl (`libssl-dev`, in debian-speak). All other dependencies
2. To build, run `make debug` or `make release`. An executable will be generated in a subdirectory of `out/`. are kept up to date in the tree.
2. To build, run `make debug` or `make release`. An executable will be
generated in a subdirectory of `out/`.
3. `make windebug` or `make winrelease` will generate a windows executable
which might work.
4. To build in docker, `docker build .`.
## Running ## Running
This is only just starting to show some signs of beginning to work as intended. Set expectations low. By default, running the built `tildefriends` executable will start a web server
at <http://localhost:12345/>. `tildefriends -h` lists further options.
Running the built `tildefriends` executable will start a web server at <http://localhost:12345/>. `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
The first user to create an account and log in will be granted administrative privileges. Everything can be managed entirely from the web interface. <http://localhost:12345/~core/admin/`>.
## Documentation ## Documentation
There are the very beginnings of developer documentation in `apps/cory/docs/` that can be read in-place or in-browser by running `tildefriends import -u cory` and then visiting <http://localhost:12345/~cory/docs/>. There are the very beginnings of developer documentation in `apps/cory/docs/`
that can be read in-place or at <http://localhost:12345/~core/docs/>.
## License ## License
All code unless otherwise noted in is provided under the [MIT](https://opensource.org/licenses/MIT) license. All code unless otherwise noted in is provided under the
[MIT](https://opensource.org/licenses/MIT) license.