3a8b2efd-8df2-4277-9336-5d97408d6574
This commit is contained in:
47
README.md
47
README.md
@@ -1 +1,46 @@
|
||||
this is a pokemon repo
|
||||
# Pokemon Battle Simulator (Gen 1)
|
||||
|
||||
A high-performance C++ library for simulating Pokemon battles from Generation 1 with maximum efficiency.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
├── src/ # Core C++ source files
|
||||
├── include/ # C++ header files
|
||||
├── data/ # Pokemon data, moves, types, etc.
|
||||
├── tests/ # Unit and integration tests
|
||||
├── benchmarks/ # Performance benchmarks
|
||||
├── tools/ # Python tooling and utilities
|
||||
├── cmake/ # CMake configuration files
|
||||
├── docs/ # Documentation
|
||||
├── examples/ # Usage examples
|
||||
└── build/ # Build artifacts (git-ignored)
|
||||
```
|
||||
|
||||
## Features (Planned)
|
||||
|
||||
- Complete Generation 1 Pokemon data
|
||||
- Accurate battle mechanics simulation
|
||||
- High-performance battle engine
|
||||
- Type effectiveness system
|
||||
- Move and ability implementations
|
||||
- AI battle strategies
|
||||
- Performance benchmarking tools
|
||||
|
||||
## Build Requirements
|
||||
|
||||
- C++17 or later
|
||||
- CMake 3.15+
|
||||
- Python 3.8+ (for tooling)
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
mkdir build && cd build
|
||||
cmake ..
|
||||
make
|
||||
```
|
||||
|
||||
## Development Tools
|
||||
|
||||
Python scripts in the `tools/` directory provide data processing, validation, and development utilities.
|
||||
Reference in New Issue
Block a user