Trying to get things ship-shape.
git-svn-id: https://www.unprompted.com/svn/projects/tildefriends/trunk@3627 ed5197a5-7fde-0310-b194-c3ffbd925b24
This commit is contained in:
parent
6ffdae6274
commit
f63242cad1
32
COPYING
32
COPYING
@ -31,9 +31,29 @@ a non-source form of such a combination shall include the source code for the
|
|||||||
parts of QuickJS used as well as that of the covered work.}
|
parts of QuickJS used as well as that of the covered work.}
|
||||||
|
|
||||||
If you modify this Program, or any covered work, by linking or combining it
|
If you modify this Program, or any covered work, by linking or combining it
|
||||||
with javascript-bcrypt (or a modified version of that library), containing
|
with libsodium (or a modified version of that library), containing parts
|
||||||
parts covered by the terms of the New BSD License, the licensors of this
|
covered by the terms of the ISC License, the licensors of this Program grant
|
||||||
Program grant you additional permission to convey the resulting work.
|
you additional permission to convey the resulting work. {Corresponding Source
|
||||||
{Corresponding Source for a non-source form of such a combination shall include
|
for a non-source form of such a combination shall include the source code for
|
||||||
the source code for the parts of javascript-bcrypt used as well as that of the
|
the parts of libsodium used as well as that of the covered work.}
|
||||||
covered work.}
|
|
||||||
|
If you modify this Program, or any covered work, by linking or combining it
|
||||||
|
with xopt (or a modified version of that library), containing parts covered by
|
||||||
|
the terms of the Apache License 2.0, the licensors of this Program grant you
|
||||||
|
additional permission to convey the resulting work. {Corresponding Source for
|
||||||
|
a non-source form of such a combination shall include the source code for the
|
||||||
|
parts of xopt used as well as that of the covered work.}
|
||||||
|
|
||||||
|
If you modify this Program, or any covered work, by linking or combining it
|
||||||
|
with crypt_blowfish (or a modified version of that library), containing parts
|
||||||
|
covered by the terms of the MIT License, the licensors of this Program grant
|
||||||
|
you additional permission to convey the resulting work. {Corresponding Source
|
||||||
|
for a non-source form of such a combination shall include the source code for
|
||||||
|
the parts of crypt_blowfish used as well as that of the covered work.}
|
||||||
|
|
||||||
|
If you modify this Program, or any covered work, by linking or combining it
|
||||||
|
with base64c (or a modified version of that library), containing parts covered
|
||||||
|
by the terms of the BSD 3-Clause License, the licensors of this Program grant
|
||||||
|
you additional permission to convey the resulting work. {Corresponding Source
|
||||||
|
for a non-source form of such a combination shall include the source code for
|
||||||
|
the parts of base64c used as well as that of the covered work.}
|
||||||
|
35
README.md
35
README.md
@ -1,41 +1,26 @@
|
|||||||
# Tilde Friends
|
# Tilde Friends
|
||||||
Tilde Friends is a program that aims to securely host and share pure JavaScript
|
Tilde Friends is a program that aims to securely host and share pure JavaScript web applications.
|
||||||
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 a security model that is easy to understand and protects your data.
|
||||||
3. Make creating and sharing web applications accessible to anyone from a web interface.
|
3. Make creating and sharing web applications accessible to anyone with a browser.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
1. Requires libsodium and openssl. Other dependencies are kept up to date in the tree.
|
1. Requires libsodium and openssl. Other dependencies are kept up to date in the tree.
|
||||||
2. To build, run:
|
2. To build, run `make` or `make DEBUG=1`. An executable will be generated in a subdirectory of `out/`.
|
||||||
```
|
|
||||||
make
|
|
||||||
```
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
```
|
|
||||||
make DEBUG=1
|
|
||||||
```
|
|
||||||
|
|
||||||
Note for Raspberry Pi: http://www.mccarroll.net/blog/v8_pi2/index.html
|
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
Running the built tildefriends executable will start a web server. This is a
|
This is only just starting to show some signs of beginning to work as intended. Set expectations low.
|
||||||
good starting point: <http://localhost:12345/>.
|
|
||||||
|
|
||||||
The first user to create an account and log in will be granted administrative
|
Running the built `tildefriends` executable will start a web server at <http://localhost:12345/>. `tildefriends -h` lists further options.
|
||||||
privileges. Everything can be managed entirely from the web interface.
|
|
||||||
|
|
||||||
This is all a work in progress.
|
The first user to create an account and log in will be granted administrative privileges. Everything can be managed entirely from the web interface.
|
||||||
|
|
||||||
|
Some starter apps can be installed by running `tildefriends import -u cory`. Hint: `~cory/docs/` and `~cory/index/`.
|
||||||
|
|
||||||
## 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/>.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
All code unless otherwise noted in
|
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.
|
||||||
[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.
|
|
||||||
|
8
deps/win32/unistd.h
vendored
8
deps/win32/unistd.h
vendored
@ -1,8 +0,0 @@
|
|||||||
#ifndef INCLUDED_unistd
|
|
||||||
#define INCLUDED_unistd
|
|
||||||
|
|
||||||
#if defined (WIN32)
|
|
||||||
typedef int32_t ssize_t;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#endif
|
|
9
tools/release.sh
Executable file
9
tools/release.sh
Executable file
@ -0,0 +1,9 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
VERSION=$1
|
||||||
|
NICKNAME=$2
|
||||||
|
rm -rfv tildefriends-$VERSION
|
||||||
|
svn export . tildefriends-$VERSION
|
||||||
|
echo "tildefriends-$VERSION: $NICKNAME" > tildefriends-$VERSION/VERSION
|
||||||
|
tar -caf tildefriends-$VERSION.tar.xz tildefriends-$VERSION
|
||||||
|
rm -rfv tildefriends-$VERSION
|
Loading…
Reference in New Issue
Block a user