cory/tildefriends
5
6
Fork 2
Code Issues 38 Pull Requests Actions Releases 33 Wiki Activity

Attempting documentation again.

Browse Source 
git-svn-id: https://www.unprompted.com/svn/projects/tildefriends/trunk@3375 ed5197a5-7fde-0310-b194-c3ffbd925b24
This commit is contained in:
Cory McWilliams
2017-01-08 16:25:07 +00:00
parent a60049b6b5
commit 15f3a3351e
2 changed files with 196 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -9,19 +9,23 @@ Tilde Friends is a program that aims to securely host pure JavaScript web applic
## Building
Tilde Friends is [routinely](https://www.unprompted.com/projects/build/tildefriends) built on Linux, Windows, and OS X.
1. Get and build [Google V8](https://code.google.com/p/v8-wiki/wiki/UsingGit) (latest 3.30).
2. Get and build [libuv](https://github.com/libuv/libuv) (latest 1.0).
1. Get and build [Google V8](https://github.com/v8/v8/wiki/Building%20from%20Source) (latest 5.5).
2. Get and build [libuv](https://github.com/libuv/libuv) (latest 1.10.1).
3. Run:
```
scons uv=path/to/libuv v8=path/to/v8
```
## Running
Running the built tildefriends executable will start a web server. This is a good starting point: <http://localhost:12345/tasks>.
Running the built tildefriends executable will start a web server. This is a good starting point: <http://localhost:12345/>.
The first use to create an account and log in will be granted administrative privileges. Everything can be managed entirely from the web interface.
This is a work in progress.
This is all a work in progress.
## Documentation
See the [users guide](docs/guide.md) for documentation.
## License
All code unless otherwise noted in [COPYING](https://www.unprompted.com/projects/browser/projects/tildefriends/trunk/COPYING) is provided under the [Affero GPL 3.0](https://www.unprompted.com/projects/browser/projects/tildefriends/trunk/LICENSE) license.