BoostFastCode is motivated to increase a contributor’s data producing capabilities through automating the collection or production of routine data. Proper citation of sources utilized in the design, production, and usage of this code is very influencial in judging code as the existence of BoostFastCode generally promotes the open source philosphy.
- WARNING
-
As Install.sh edits the user’s .bashrc and it’s bebehavior is only known on WSL 2 Ubuntu 20.04, prospective contributers should thoroughly consider understanding features prior to utilizing them for their own safety.
Being a private git repo, setup complications related to receiving permission from your remote github account when pushing to remote origin should be expected. To download BoostFastCode for pure usage and no plans to write back to the remote repository a browser .zip download should be considered. For the git literate contribute as you feel inspired.
Once the remote origin is cloned, navigate to: BoostFastCode/booster-shot/shell-history/Install.sh
image::BoostFastCodeFileStructure.PNG
- WARNING
-
Avoiding inflation of time spent debugging the setup, ensure all files used by the Install.sh script have sufficient read write permissions.
-
BoostFastCode subdirectories
-
User basrc file
Determine the location of BoostFastCode’s dependancies in Install.sh’s local variables.
Boosts are organized into directories located in BoostFastCode/boosts/<boost-dir-name>. Boost infrastructure isn’t universal, however the common design behind each boost is similar to the DocHead Boost:
-
README.adoc
-
dochead.sh
-
<some weird misc files>
-
docheaders/
- INFO
-
Organize large sets of boost local redundant data like assets/ into subdirectories of their respective boost.
The following boosts are fairly stable.
ordered in descending usability
-
Dochead
-
VimStuff
-
TheMathematics
|
Warning
|
ASSUME ALL BOOSTS LOCATED IN A BOOST DIR IN BoostFastCode/boosts/ NOT LISTED IN THE FOLLOWING ARE UNSTABLE. |