My PICAXE BASIC headerfile libraries

Documentation and instructions for using rand_logic.basinc (the only library here right now)

I'll separate the documentation for each library into their own directories (as well as moving the libraries into those directories) when there's more than one library here

If your project doesn't use Git, clone the repository with git clone https://github.com/CyberFlameGO/PICAXE_BASIC_libs.git (HTTPS cloning) or git clone git@github.com:CyberFlameGO/PICAXE_BASIC_libs.git (SSH cloning) in your project's directory. If your project does use Git, add this repository as a submodule with git submodule add https://github.com/CyberFlameGO/PICAXE_BASIC_libs.git (HTTPS) or git submodule add git@github.com:CyberFlameGO/PICAXE_BASIC_libs.git (SSH) in your project root directory.

Once you've done that, include the headerfile/s you're using into your code. You do this by putting this at the top of your BASIC code file:

#include "<FILE LOCATION EXCLUDING ANGLE BRACKETS>"

Example

Scenario

I have a file called main.bas in working directory /Users/cyberflame/Documents/PICAXE/main.bas and I've run git submodule add https://github.com/CyberFlameGO/PICAXE_BASIC_libs.git in /Users/cyberflame/Documents/PICAXE/, and I wanted to use dice_gen(w1, 5, b4) in my main.bas file.

How I do this:

#include "./PICAXE_BASIC_libs/rand_logic.basinc"
;The ./ signifies that the location I'm referencing is relative to where this file's location is

main:
      dice_gen(w1, 6, b4)
      ;w1 is where we store the original random number, 6 is for a number including and between 0 - 5, and b4 is for the new number
      goto main

Confused?

Please submit an issue outlining what you need clarification on, or drop me an email at cyberflameu@gmail.com. You can take a look at my GitHub profile for other mediums in which you can contact me if none of these satisfy your needs for a means of contact