summaryrefslogtreecommitdiffstats
path: root/share/coins/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'share/coins/README.txt')
-rw-r--r--share/coins/README.txt84
1 files changed, 84 insertions, 0 deletions
diff --git a/share/coins/README.txt b/share/coins/README.txt
new file mode 100644
index 0000000..b523695
--- /dev/null
+++ b/share/coins/README.txt
@@ -0,0 +1,84 @@
+/******************************************************************************
+ * vision-artificial Copyright (C) 2018 Alejandro Colomar Andrés *
+ * *
+ * This program is free software; you can redistribute it and/or modify *
+ * it under the terms of the GNU General Public License as published by *
+ * the Free Software Foundation, version 2. *
+ * *
+ * This program is distributed in the hope that it will be useful, *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
+ * GNU General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU General Public License *
+ * along with this program; if not, see the file COPYING, or write *
+ * to the Free Software Foundation, Inc. *
+ ******************************************************************************
+ * Disclaimer of Warranty. *
+ * *
+ * THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY *
+ * APPLICABLE LAW. *
+ * *
+ * EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER *
+ * PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER *
+ * EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED *
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. *
+ * *
+ * THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH *
+ * YOU. *
+ * *
+ * SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY *
+ * SERVICING, REPAIR OR CORRECTION. *
+ ******************************************************************************/
+
+ If you make a version, please tell me.
+ I would like to see it. Thank you.
+
+site:
+ https://github.com/AlejandroColomar/vision-artificial
+
+
+COMPILE:
+ $ make
+
+INSTALL:
+ # make install
+
+RUN:
+ $ vision-artificial
+ if it doesn't work:
+ $ /usr/local/games/vision-artificial
+
+UNINSTALL:
+ # make uninstall
+
+
+The program creates a folder '.vision-artificial/' at $HOME. It
+is used by the program to store saved images. If you remove the program, you
+should delete that folder manually.
+
+
+THE PROGRAM DOES:
+ // FIXME
+
+
+MENU:
+ When you run the program, it starts in a menu that has these branches:
+
+ /*
+ * + Menu:
+ * + Continue:
+ * - Start
+ * - Change file name (File: "<file_name>")
+ * - ..
+ * - Disclaimer of warranty
+ * - Terms and conditions
+ * - Exit program
+ */
+
+
+SYSTEM REQUIREMENTS:
+
+ * ¿?
+
+To be continued...