ceev/README.md

59 lines
791 B
Markdown
Raw Normal View History

2022-12-20 15:13:07 +00:00
# CeeV
A simple visual novel engine written in C++.
## Usage
### Building
CeeV uses CMake to build. To build, run the following commands:
```bash
mkdir build
cd build
cmake ..
make
2023-01-15 14:43:08 +00:00
sudo make install
2022-12-20 15:13:07 +00:00
```
### Initializing a project
2022-12-20 15:13:07 +00:00
Make a new folder, then run the following command:
2022-12-20 15:13:07 +00:00
```bash
2023-01-15 14:43:08 +00:00
ceev init
2022-12-20 15:13:07 +00:00
```
### Building the project
2022-12-20 15:13:07 +00:00
Run the following command:
```bash
2023-01-15 14:43:08 +00:00
ceev build
```
### Running the project
Run the following command:
```bash
2023-01-15 14:43:08 +00:00
ceev run
```
### More help
Run the following command:
```bash
2023-01-15 14:43:08 +00:00
ceev --help
```
if you need more help.
2022-12-20 15:13:07 +00:00
## License
CeeV is licensed under the AGPL-3.0 License. See [LICENSE](LICENSE) for more information.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.