From f63242cad133cee975b2ee0120bf80a09a55ed43 Mon Sep 17 00:00:00 2001 From: Cory McWilliams Date: Sun, 3 Jan 2021 20:10:29 +0000 Subject: [PATCH] Trying to get things ship-shape. git-svn-id: https://www.unprompted.com/svn/projects/tildefriends/trunk@3627 ed5197a5-7fde-0310-b194-c3ffbd925b24 --- COPYING | 32 ++++++++++++++++++++++++++------ README.md | 35 ++++++++++------------------------- deps/win32/unistd.h | 8 -------- tools/release.sh | 9 +++++++++ 4 files changed, 45 insertions(+), 39 deletions(-) delete mode 100644 deps/win32/unistd.h create mode 100755 tools/release.sh diff --git a/COPYING b/COPYING index a019d6cd..811bafaa 100644 --- a/COPYING +++ b/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.} 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 -parts covered by the terms of the New BSD 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 javascript-bcrypt used as well as that of the -covered work.} +with libsodium (or a modified version of that library), containing parts +covered by the terms of the ISC 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 libsodium used as well as that of the 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.} diff --git a/README.md b/README.md index 8cf31cef..128bc6c6 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,26 @@ # Tilde Friends -Tilde Friends is a program that aims to securely host and share pure JavaScript -web applications. +Tilde Friends is a program that aims to securely host and share pure JavaScript web applications. ## Goals 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. -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 1. Requires libsodium and openssl. Other dependencies are kept up to date in the tree. -2. To build, run: - ``` - make - ``` - - or - - ``` - make DEBUG=1 - ``` - -Note for Raspberry Pi: http://www.mccarroll.net/blog/v8_pi2/index.html +2. To build, run `make` or `make DEBUG=1`. An executable will be generated in a subdirectory of `out/`. ## Running -Running the built tildefriends executable will start a web server. This is a -good starting point: . +This is only just starting to show some signs of beginning to work as intended. Set expectations low. -The first user to create an account and log in will be granted administrative -privileges. Everything can be managed entirely from the web interface. +Running the built `tildefriends` executable will start a web server at . `tildefriends -h` lists further options. -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 +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 . ## 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. +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. diff --git a/deps/win32/unistd.h b/deps/win32/unistd.h deleted file mode 100644 index 663aacf5..00000000 --- a/deps/win32/unistd.h +++ /dev/null @@ -1,8 +0,0 @@ -#ifndef INCLUDED_unistd -#define INCLUDED_unistd - -#if defined (WIN32) -typedef int32_t ssize_t; -#endif - -#endif diff --git a/tools/release.sh b/tools/release.sh new file mode 100755 index 00000000..60907120 --- /dev/null +++ b/tools/release.sh @@ -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