dropping an unnecessary subdirectory
[feisty_meow.git] / readme.txt
1
2 ==============
3
4 Quick Start Guide for the Feisty Meow Codebase
5
6 Commands that can be typed in a console or terminal are are prefixed with "#".
7 Information that varies by platform is prefixed with a '|' character.
8
9 ==============
10
11 How to get the feisty meow codebase
12
13 | On Microsoft Windows, install the Cygwin tools as documented here:
14 | ~/feisty_meow/documentation/cygwin_install_list.txt (local file) or
15 | https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
16
17 Retrieve a clone of the feisty meow codebase:
18 # git clone git://feistymeow.org/feisty_meow
19
20 The remainder of these notes assume that the code is stored in:
21   ~/feisty_meow (aka $HOME/feisty_meow).
22
23 ==============
24
25 How to load the feisty meow script environment
26
27 Set up the feisty_meow scripts; this is only needed once, when you first get
28 the codebase.  It will also regenerate the scripts using the latest installed
29 version.
30 # bash ~/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
31
32 Connect the feisty meow scripts to your login script (in ~/.bashrc).
33 Note that this actually modifies ~/.bashrc.  This step is only needed once.
34 # bash ~/feisty_meow/scripts/core/connect_feisty_meow.sh
35
36 Load the script environment into the current shell.  This can be done for
37 any new shell.  This is idempotent, so it does no harm to run it again.
38 Note that you should not need this step if you connected feisty meow to
39 ~/.bashrc above.
40 # source ~/feisty_meow/scripts/core/launch_feisty_meow.sh
41
42 When the feisty meow script environment loaded, many new aliases and
43 functions are available for use.  These come from the $FEISTY_MEOW_SCRIPTS
44 folder.
45 See the full list of commands at:
46 (hmmm: To be completed in 2018)
47
48 ==============
49
50 How to install the feisty meow script dependencies
51
52 A couple of perl modules are required by some of the scripts (including the
53 differ utility and the feisty meow customization system).  They can be
54 installed with either apt-get or CPAN.
55
56 Install using apt-get:
57 # sudo apt-get install libfile-which-perl libtext-diff-perl
58
59 or Install using perl's CPAN:
60 # sudo cpan install Text::Diff File::Which
61
62 ==============
63
64 How to install the build dependencies for feisty meow
65
66 These dependencies are used for building the applications, tools and tests
67 in the "nucleus", "octopi", "graphiq" and other C++ collections.
68
69 | Ubuntu / Debian:
70 | # sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
71
72 | Centos / Redhat / Fedora:
73 | # sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
74
75 | Microsoft Windows:
76 | Download and install the Cygwin environment first from cygwin.com, which is
77 | documented in ~/feisty_meow/documentation/cygwin_install_list.txt
78
79 The "kona" collection depends on Java version 8 or better.
80
81 | Ubuntu:
82 | Set up the java PPA archive as described here:
83 | https://launchpad.net/~webupd8team/+archive/ubuntu/java
84
85 ==============
86
87 How to build the feisty meow codebase
88
89 Run the following command to build the feisty meow libraries and applications.
90 # produce_feisty_meow
91
92 After the build is complete, the feisty meow applications can be found in
93 $FEISTY_MEOW_BINARIES (environment variable).
94 # ls $FEISTY_MEOW_BINARIES 
95
96 ==============
97
98 How to clean up the files generated by the build
99
100 This command cleans out all the generated files:
101 # whack_build clean
102
103 ==============
104
105 What are the feisty meow dependencies?
106
107 The feisty meow scripts depend on these scripting languages and tools:
108   bash
109   perl (including Text::Diff and File::Which)
110   python
111   gnumake
112
113 The feisty meow libraries and applications depend on these tools:
114   Gnu C++
115   RTMP streams (?still?  not sure.)
116   Curl
117   Open SSL
118
119 The feisty meow "kona" library depends on these languages:
120   Java
121
122 ==============
123
124 Bug reporting
125
126 Report bugs at the feisty meow trac site:
127 https://trac.feistymeow.org/projects/feistymeow/report
128 Email fred@gruntose.com for authorization to write up new bug reports.
129
130 There is also a github mirror of feisty meow at:
131 https://github.com/fredhamster/feisty_meow
132 The github repository will accept bug reports without an authorization process.
133
134 ==============
135
136 More information is available at the official site: https://feistymeow.org
137
138 ==============
139