Add a generic I/O error
4 files changed
tree: 59988b7398d31fa92d1d146027c91242a79cd91f
  1. include/
  2. src/
  3. tests/
  4. .gitignore
  5. .gitmodules
  6. LICENSE.md
  7. Makefile
  8. NOTICE.md
  9. README.md
README.md

bc

This is an implementation of POSIX bc that implements GNU bc extensions.

This bc is Free and Open Source Software (FOSS). It is licensed under the BSD 3-clause License, with a special exemption for the Toybox project and the Android Open Source Project to use it under the BSD 0-clause License.

Because this bc makes use of arbprec by cmgraff and hexingb et al, this bc is a collaborative effort. All arbprec contributors are considered bc contributors.

Status

This bc is not even in alpha stage yet, so it is not ready for use. However, at this time, it can do basic math operations (+, -, *, /, %) on constants.

Cloning

After cloning, make sure to run git submodule update --init --recursive to clone the arbprec submodule.

Language

Gam is written in pure ISO C11.

Git Workflow

Gam uses the git workflow described in this post. Developers who want to contribute to Gam are encouraged to read that post carefully.

For feature branches, it uses rebase + merge --no--ff (option 3). It also uses a master/release split. (Main development is on master, and release just points to the latest tagged release to make it easy for users to get the latest release.)

Gam includes scripts and a .gitconfig that helps manage the workflow. New contributors should familiarize themselves with them.

Commit Messages

Gam uses the commit message guidelines laid out in this blog post.

Semantic Versioning

Gam uses semantic versioning.

Contents Listing

Every folder contains a README file which lists the purposes for the files and folders in that directory.

Contents

Files:

LICENSE.md      A Markdown version of Pixar's modified Apache 2.0 license.
NOTICE.md       The NOTICE file required by the Apache License.

Folders:

docs        Contains all of the documentation for Gam (currently empty).
include     Contains all of the public header files for Gam.
src         All of Gam's source code.
tests       Tests for Gam.