Awesome

Android.Brainf

Interpreter for the 'Brainf' programming language

• Features
• Screenshots
• Documentation
• Installation
• Gradle tasks
• Kotlin and Android Version
• Building From Source
  • Git Clone
    • Using The Command Line
    • Using GitHub Desktop
  • (or) Download Zip File
  • Download Android Studio
• Community Files
  • Licence
  • Changelog
  • Code of Conduct
  • Contributing
  • Security
  • Support
  • Development Info

Features

• Integration with System Theme: Brainf seamlessly integrates with the system's theme, ensuring that the app's appearance aligns with the user's device-wide design choices.

• Effortless Code Management: Easily create, edit, save, and execute Brainf code and text files, providing a comprehensive platform for coding endeavours.

• Vibrant Syntax Highlighting: Harness the power of regex-based syntax highlighting, making your code structures and elements vividly distinct for enhanced readability and comprehension.

• Swift Navigation via Launcher Shortcuts: Instantly access key sections like Settings, About, and New File through convenient launcher shortcuts, streamlining your interaction with the app for maximum efficiency.

• ASCII Control Character Support: supporting two notation types for ASCII control characters: hexadecimal notation (\xNN) and control character notation (@NAME;), allowing flexible inclusion of control sequences in input strings.

Screenshots

Documentation

A high-level overview of how the documentation is organized organized will help you know where to look for certain things:

• Tutorials take you by the hand through a series of steps to get started using the software. Start here if you’re new.

• The Technical Reference documents APIs and other aspects of the machinery. This documentation describes how to use the classes and functions at a lower level and assume that you have a good high-level understanding of the software.

Installation

You can install the app using the following methods, Follow the link to the listing on your preferred store by clicking on one of the badges below, then download/install:

<img src="readme-assets/badges/badge_obtainium.png" alt="Get it on Obtainium" height="80"> <img src="readme-assets/badges/badge_fdroid.png" alt="Get it on F-Droid" height="80"> <img src="readme-assets/badges/badge_gplay.png" alt="Get it on Google Play" height="80"> <img src="readme-assets/badges/badge_github.png" alt="Get it on GitHub" height="80">

Build from Source

Follow the steps in the Building from Source section.

Gradle tasks

• ktlintCheck (gradlew ktlintCheck): run ktlint over the codebase
• genDocs (gradlew genDocs): generate the api reference using dokka

Kotlin and Android Version

This app has been written in Kotlin 1.9.0 with the Android Studio IDE.

• The target SDK version is 33 (Android 13)
• The minimum SDK version is 26 (Android 8 Oreo)

Building From Source

1. Download or clone this GitHub repository
2. (If downloaded) Extract the zip archive
3. In Android Studio click File > Open and then navigate to the project file (Android studio defaults to the directory of the last opened file)

Git Clone

Using The Command Line

1. Press the Clone or download button in the top right

2. Copy the URL (link)

3. Open the command line and change directory to where you wish to clone to

4. Type 'git clone' followed by URL in step 2

   git clone https://github.com/FredHappyface/Android.Brainf
   

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

1. Press the Clone or download button in the top right
2. Click open in desktop
3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

(or) Download Zip File

1. Download this GitHub repository
2. Extract the zip archive
3. Copy/ move to the desired location

Download Android Studio

Download the Android Studio IDE from https://developer.android.com/studio/. For Windows, double click the downloaded .exe file and follow the instructions provided by the installer - it will download the Android emulator and the Android SDK. Additional information can be found at https://developer.android.com/studio/install

Community Files

Licence

MIT License (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Code of Conduct

Our project welcomes individuals from diverse backgrounds and perspectives. We are committed to providing a friendly, safe and welcoming environment for all. Please see the Code of Conduct for more information.

Contributing

Your contributions are valuable and help improve the project for everyone, please see the Contributing Guidelines for more information.

Security

If you discover a security vulnerability, we appreciate your responsible disclosure. Please see the Security Policy for more information.

Support

Thank you for using this project, I hope it is of use to you. Please keep in mind that the folks working on this project are enthusiasts with various commitments such as work, family, and other passions. See the Support Policy for more information.

Development Info

Serves as a guide to various aspects of project development, including versioning, style guidelines, and recommended practices. Please see Development Info for more information.