# xcShell

**Repository Path**: superxcgm/xcShell

## Basic Information

- **Project Name**: xcShell
- **Description**: No description available
- **Primary Language**: C++
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-27
- **Last Updated**: 2021-10-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xcShell - build your own wheel
![](https://github.com/superxcgm/xcShell/actions/workflows/ci.yml/badge.svg)

[KANBAN](https://github.com/users/superxcgm/projects/4)

## Usage
1. `git clone https://github.com/superxcgm/xcShell.git`
2. `cd xcShell`
3. `./auto/build.sh`
4. `./auto/install.sh`
5. `xcShell`

## Build
```shell
./auto/build.sh
```

## Format Your Code
```shell
./auto/format.sh
```

## Run
```shell
./auto/run.sh
```

## Check Code Style
```shell
./auto/lint.sh
```

## Unit Test
```shell
./auto/test.sh
```

## Functional Test
### Run
```shell
./auto/functional_test.sh run
```

### Add a New Test Suite
```shell
./auto/functional_test.sh generate xxx
# For example: ./auto/functional_test.sh generate pipe
```
This command will generate empty file `xxx.functional_test.in` and `xxx.functional_test.expected.out` in dir `auto/data`.
And then you can write your test in `xxx.functional_test.in`, run functional test and check output of you test.
It should be located in `/tmp/xcShell_functional_test/xxx.functional_test.out`.

You can save output by `./auto/functional_test.sh apply xxx` if the output file match you expect.

## Contribution Guideline
[Link](https://github.com/superxcgm/xcShell/wiki/Contribution-Guideline)