biicode’s getting started with OpenSSL, Git and GitHub

Today’s post is biicode’s getting started guide with Git and GitHub. We will depend on OpenSSL v1.0.2 biicode block to generate MD5 (Message-Digest Algorithm 5) and SHA-1 (Secure Hash Algorithm) hashes in your Terminal.

Getting started with Git and GitHub in biicode

Before anything else (of course), you’ll need Git, CMake > 3.0, biicode > 2.6 and both accounts: GitHub and biicode.

Make sure you have all them, run --version in your terminal:

Now, let’s begin with Git and Github!

Create a GitHub repo on the web page and copy the repo’s URL:

Create a new GitHub repo

Copy the recently created GitHub repo's URL

Now, go back to your terminal. Clone the repo (this clones an empty git folder for your project to live in), navigate to that folder and run bii init -L :

Write the code

Create three files: a sha1.cpp a md5.cpp to generate both hashes, SHA1 and MD5, and also a biicode.conf file.

sha1.cpp code

md5.cpp code

biicode.conf

– biicode’s configuration file

Fill the biicode.conf file so bii gets the OpenSSL v1.0.2. dependencies your project needs via [requirements] and [includes] sections:

biicode.conf

open_ssl_sha1_biicode

running your project

bii build and you’re ready to run your project and check the generated MD5 and SHA-1 hashes.

What bii files/folders does your repo need?

Your GitHub repo only needs biicode.conf file, a CMakeLists.txt and your code. You can safely ignore bii/ and bin/ folders as they’re auxiliary. bii/ holds subfolders like cmake/, build/ or deps/, and bin/ contains the output binaries, frequently ignored too.

Create a .gitignore file and write bii and bin to ignore both folders:

Add and commit your changes:

Share your code

It’s finally time to share your code. Now all is setup to push your project to GitHub and publish a biicode block referring to your GitHub repo:

Want a repo with the files needed? Just fork mine  and go!

There are many options available to automatically publish (to biicode) from GitHub. We usually use Travis-ci and Appveyor to achieve so:

For those who enjoy using multiple blocks at the same time, we recommend using a git repo for each biicode block.

Don’t forget that all layouts are fully customizable via layout.bii file, check all the options available in the docs section: Customizing your layout.

As always, we’re available at our forum or Stackoverflow tag. You can also write us and request features at our roadmap.


Related Posts