# wbf

**Repository Path**: ghosind/wbf

## Basic Information

- **Project Name**: wbf
- **Description**: 一个简单的C语言实现BrainFuck解释器
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-06
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 解释器, brainfuck

## README

# wbf

![Travis CI](https://travis-ci.org/ghosind/wbf.svg?branch=master)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a598d95b481b40b186098092e71f38e4)](https://www.codacy.com/manual/ghosind/wbf?utm_source=github.com&utm_medium=referral&utm_content=ghosind/wbf&utm_campaign=Badge_Grade)

A simple BrainFuck language interpreter.

## Getting Start

### Dependencies

Wbf require readline library, you should install libreadline before build it.

For Mac OS:

```sh
$ brew install readline
```

For CentOS / Fedora:

```sh
$ yum install readline-devel
```

For Debian / Ubuntu:

```sh
$ apt-get install libreadline-dev
```

### Build

Just run `make`, and it will generate binary file `wbf` to the `dist` directory.

### Usage

```
$ wbf [file_name]
```

## Commands

| Command | Description |
| :-----: | :---------: |
|   `<`   |	Move the pointer to the previous position |
|   `>`   | Move the pointer to the next position |
|   `+`   | Increment the memory cell under the pointer |
|   `-`   | Decrement the memory cell under the pointer |
|   `.`   | Print the character signified by the memory cell at the pointer |
|   `,`   | Read a character and store it in the memory cell at the pointer |
|   `[`   | Jump past the matching `]` if the memory cell at the pointer is zero |
|   `]`   | Jump back to the matching `[` if the memory cell at the pointer is nonzero |

## Example

The program prints the word: Hello World!

```bf
++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.
```

## Contribution

1. Fork the Project.
2. Create your Branch. (`git checkout -b features/someFeatures`)
3. Commit your Changes. (`git commit -m 'Add some features'`)
4. Push to the Branch. (`git push origin features/someFeatures`)
5. Create a new Pull Request.

## License

Distributed under the GPLv3 License. See [LICENSE](./LICENSE) for more information.

## Credits

- [https://esolangs.org/wiki/Brainfuck](https://esolangs.org/wiki/Brainfuck)