-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
03800f3
commit c2fcd3b
Showing
2 changed files
with
172 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
<div id="top"></div> | ||
|
||
<!-- PROJECT SHIELDS --> | ||
[![Contributors][contributors-shield]][contributors-url] | ||
[![Forks][forks-shield]][forks-url] | ||
[![Stargazers][stars-shield]][stars-url] | ||
[![Issues][issues-shield]][issues-url] | ||
[![MIT License][license-shield]][license-url] | ||
|
||
|
||
|
||
<!-- PROJECT LOGO --> | ||
<br /> | ||
<div align="center"> | ||
<a href="https://github.com/Sellig6792/FuckBrainfuck"> | ||
<img src="assets/logo.png" alt="Logo" width="80" height="auto"> | ||
</a> | ||
|
||
### FuckBrainfuck | ||
[Explore documentation](https://github.com/Sellig6792/FuckBrainfuck/wiki) | [Report Bug](https://github.com/Sellig6792/FuckBrainfuck/issues) | [Request Feature](https://Sellig6792/FuckBrainfuck/issues) | ||
</div> | ||
<br/> | ||
|
||
|
||
|
||
<!-- TABLE OF CONTENTS --> | ||
1. [About the Project](#about-the-project) | ||
2. [Installation](#installation) | ||
- [Prebuilt Binaries](#1-prebuilt-binaries) | ||
- [Building from Source](#2-building-from-source) | ||
3. [Usage](#usage) | ||
4. [Contributing](#contributing) | ||
5. [License](#license) | ||
6. [Contact](#contact) | ||
7. [Acknowledgements](#acknowledgements) | ||
|
||
|
||
|
||
|
||
|
||
<!-- ABOUT THE PROJECT --> | ||
## About The Project | ||
|
||
It all started on the Discord server of Graven, on 26<sup>th</sup> June 2022. | ||
It was a joke that ended up on this shit... | ||
|
||
So FuckBrainfuck was born. It is an improvement of the classic BrainFuck, with some new features and new commands. | ||
|
||
We have already implemented: | ||
|
||
- Functions | ||
- "Safe" comments | ||
- Scopes for functions | ||
- Optimization | ||
|
||
|
||
|
||
### Built With | ||
![Rust][rust-shield] ![Cargo][cargo-shield] | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
|
||
## Installation | ||
|
||
### 1. Prebuilt binaries | ||
|
||
You can download the prebuilt binaries from the [releases page](https://github.com/Sellig6792/FuckBrainfuck/releases). | ||
If your system is not supported, you can [build it yourself](#2-building-from-source). | ||
|
||
### 2. Building from source | ||
|
||
You need to have [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) installed. | ||
|
||
```sh | ||
git clone https://github.com/Sellig6792/FuckBrainfuck.git | ||
cd FuckBrainfuck | ||
cargo build --release | ||
``` | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
<!-- USAGE EXAMPLES --> | ||
## Usage | ||
``` | ||
fbf [OPTIONS] <FILE> | ||
``` | ||
|
||
### Options | ||
`-O, --optimize` Optimize the code before executing it | ||
|
||
`-V, --version` Prints version information | ||
|
||
`-h, --help` Prints help information | ||
|
||
|
||
|
||
[//]: # (<p align="right">(<a href="#top">back to top</a>)</p>) | ||
|
||
|
||
<!-- CONTRIBUTING --> | ||
## Contributing | ||
|
||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. | ||
Any contributions you make are **greatly appreciated**. | ||
|
||
If you have a suggestion that would make this better, please fork the repo and create a pull request. | ||
You can also simply open an issue with the tag "enhancement". | ||
Don't forget to give the project a star! Thanks again! | ||
|
||
1. Fork the Project | ||
2. Checkout the develop branch: `git checkout develop` | ||
3. Create your Feature Branch: `git branch feat/AmazingFeature` | ||
4. Commit your Changes: `git commit -m 'Add some AmazingFeature'` | ||
5. Push to the Branch: `git push origin feat/AmazingFeature` | ||
6. Open a Pull Request to the develop branch and explain your changes | ||
|
||
|
||
|
||
<!-- LICENSE --> | ||
## License | ||
|
||
Distributed under the MIT License. See [the licence](./LICENSE) for more information. | ||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
|
||
<!-- CONTACT --> | ||
## Contact | ||
|
||
Sellig6792 - [@Sellig6792](https://twitter.com/Sellig6792) - [email protected] | ||
|
||
|
||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
|
||
<!-- ACKNOWLEDGEMENTS --> | ||
## Acknowledgements | ||
|
||
* [Wikipedia - Brainfuck][wikipedia-brainfuck-url] | ||
* [Astremy - Brainfuck Course (French)][astremy-brainfuck-pdf] | ||
<p align="right">(<a href="#top">back to top</a>)</p> | ||
|
||
|
||
|
||
<!-- MARKDOWN LINKS & IMAGES --> | ||
[contributors-shield]: https://img.shields.io/github/contributors/Sellig6792/FuckBrainfuck.svg?style=for-the-badge | ||
[contributors-url]: https://github.com/Sellig6792/FuckBrainfuck/graphs/contributors | ||
|
||
[forks-shield]: https://img.shields.io/github/forks/Sellig6792/FuckBrainfuck.svg?style=for-the-badge | ||
[forks-url]: https://github.com/Sellig6792/FuckBrainfuck/network/members | ||
|
||
[stars-shield]: https://img.shields.io/github/stars/Sellig6792/FuckBrainfuck.svg?style=for-the-badge | ||
[stars-url]: https://github.com/Sellig6792/FuckBrainfuck/stargazers | ||
|
||
[issues-shield]: https://img.shields.io/github/issues/Sellig6792/FuckBrainfuck.svg?style=for-the-badge | ||
[issues-url]: https://github.com/Sellig6792/FuckBrainfuck/issues | ||
|
||
[license-shield]: https://img.shields.io/github/license/Sellig6792/FuckBrainfuck.svg?style=for-the-badge | ||
[license-url]: https://github.com/Sellig6792/FuckBrainfuck/blob/main/LICENSE | ||
[rust-shield]: https://img.shields.io/badge/-rust-black.svg?style=for-the-badge&logo=rust&colorB=555 | ||
[cargo-shield]: https://img.shields.io/badge/-cargo-black.svg?style=for-the-badge&logo=rust&colorB=555 | ||
[brainFuck-url]: https://en.wikipedia.org/wiki/Brainfuck | ||
[brainFuck-shield]: https://img.shields.io/badge/-BrainFuck-black.svg?style=for-the-badge&logo=brainfuck&colorB=555 | ||
|
||
[graven-discord-url]: https://discord.gg/graven | ||
[astremy-brainfuck-pdf]: https://cdn.discordapp.com/attachments/815331771197030441/824402769397940234/brainfuck.pdf | ||
[wikipedia-brainfuck-url]: https://en.wikipedia.org/wiki/Brainfuck |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.