Add README

This commit is contained in:
John Doe 2023-03-21 17:23:23 -04:00
parent ac3d7f85e9
commit c0f5f74a4a
3 changed files with 10 additions and 2 deletions

5
README.md Normal file
View file

@ -0,0 +1,5 @@
# FTU - the FemtoStar Token Utility
FTU is a command line frontend for fstoken, FemtoStar's implementation of its Credit Token system, allowing users to manually generate, sign, handle, and validate Credit Tokens for use with the FemtoStar Protocol. It is, at present, developed and tested only on GNU/Linux.
FTU can be used with arbitrary targets, including user-generated ones, and at present it does not include any. To use it, you will need a directory at your token path containing a directory named `targets`. Set the environment variable FEMTOSTAR_TOKEN_PATH to the path you want to store your targets at. For testing without modifying your environment, you can run `source set_token_path.sh` to set the token path, by default to `~/fstokens` in your home directory, and, if needed, create these directories.

2
ftu.c
View file

@ -492,7 +492,7 @@ int list_targets(bool verbose){
#endif
if(n == -1){
fprintf(stderr, "Could not list directory at token path.\n");
fprintf(stderr, "Could not list targets directory in token path. Does it exist?\n");
exit(1);
}

View file

@ -1,3 +1,6 @@
#!/bin/bash
# source this file to set your token path, or add this to your profile
export FEMTOSTAR_TOKEN_PATH=~/fstokens
export FEMTOSTAR_TOKEN_PATH=~/fstokens
mkdir -p $FEMTOSTAR_TOKEN_PATH
mkdir -p $FEMTOSTAR_TOKEN_PATH/targets