Update README.md
This commit is contained in:
parent
2c936b8eb3
commit
b01d8c0eb7
1 changed files with 14 additions and 13 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# SLOP Monolith Server
|
||||
# SLOP Terminal Server
|
||||
|
||||
A comprehensive SLOP (Streamlined Language Operations Protocol) server implementation with AI model integration, sandboxed code execution, and gaming capabilities.
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ A comprehensive SLOP (Streamlined Language Operations Protocol) server implement
|
|||
1. **Clone the repository**:
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd slop-monolith
|
||||
cd slop-terminal
|
||||
```
|
||||
|
||||
2. **Run the setup**:
|
||||
|
|
@ -61,7 +61,7 @@ A comprehensive SLOP (Streamlined Language Operations Protocol) server implement
|
|||
|
||||
3. **Test the installation**:
|
||||
```bash
|
||||
./test_firecracker.sh # Auto-generated by setup
|
||||
./Scripts/test_firecracker.sh # Auto-generated by setup
|
||||
```
|
||||
|
||||
4. **Start the server**:
|
||||
|
|
@ -229,7 +229,7 @@ curl -X POST http://localhost:31337/tools/slots \
|
|||
make help # Show all available commands
|
||||
make setup # Run vars.sh setup
|
||||
make install # Install Python dependencies
|
||||
make run # Start the server
|
||||
make run # Start the server (python3 slop_with_terminal.py)
|
||||
make test # Run tests
|
||||
make clean # Clean up generated files
|
||||
make docker-build # Build Docker image
|
||||
|
|
@ -238,8 +238,8 @@ make docker-run # Run with Docker Compose
|
|||
|
||||
### Project Structure
|
||||
```
|
||||
slop-monolith/
|
||||
├── server.py # Main Flask server
|
||||
slop-terminal/
|
||||
├── slop_with_terminal.py # Main Flask server
|
||||
├── vars.sh # Setup and configuration script
|
||||
├── README.md # This file
|
||||
├── requirements.txt # Python dependencies
|
||||
|
|
@ -253,15 +253,15 @@ slop-monolith/
|
|||
├── docs/ # Documentation
|
||||
├── tests/ # Test files
|
||||
├── static/ # Static files
|
||||
├── Scripts/ # Generated scripts (auto-generated by vars.sh)
|
||||
│ ├── set_env.sh # Environment setup
|
||||
│ ├── test_firecracker.sh # Test script
|
||||
│ └── start_firecracker.sh # Firecracker wrapper
|
||||
├── data/ # Data directory
|
||||
│ ├── memory.json # Memory storage
|
||||
│ ├── resources.json # Resource storage
|
||||
│ ├── terminal/ # Terminal data
|
||||
│ └── slop_monolith.log # Server logs
|
||||
├── scripts/ # Generated scripts (gitignored)
|
||||
│ ├── set_env.sh # Environment setup (auto-generated)
|
||||
│ ├── test_firecracker.sh # Test script (auto-generated)
|
||||
│ └── start_firecracker.sh # Firecracker wrapper (auto-generated)
|
||||
├── firecracker/ # Firecracker components
|
||||
│ ├── kernel/ # Kernel images
|
||||
│ └── rootfs/ # Root filesystems
|
||||
|
|
@ -295,7 +295,7 @@ sudo usermod -a -G kvm $USER
|
|||
**Firecracker Not Working**:
|
||||
```bash
|
||||
# Test Firecracker setup
|
||||
./test_firecracker.sh # Auto-generated by setup
|
||||
./Scripts/test_firecracker.sh # Auto-generated by setup
|
||||
|
||||
# Check KVM availability
|
||||
ls -la /dev/kvm
|
||||
|
|
@ -321,6 +321,7 @@ FLASK_DEBUG=true
|
|||
|
||||
# Then start server
|
||||
make run
|
||||
# or directly: python3 slop_with_terminal.py
|
||||
```
|
||||
|
||||
## Performance Tuning
|
||||
|
|
@ -355,7 +356,7 @@ This project is released under the Public Domain. See the original SLOP specific
|
|||
For issues and questions:
|
||||
- Check the troubleshooting section
|
||||
- Review server logs in `data/slop_monolith.log`
|
||||
- Test with `./test_firecracker.sh` (auto-generated by setup)
|
||||
- Test with `./Scripts/test_firecracker.sh` (auto-generated by setup)
|
||||
- Use `make help` to see all available commands
|
||||
- Verify endpoints with curl
|
||||
|
||||
|
|
@ -369,7 +370,7 @@ For issues and questions:
|
|||
```bash
|
||||
# Clone and navigate to project
|
||||
git clone <repository-url>
|
||||
cd slop-monolith
|
||||
cd slop-terminal
|
||||
|
||||
# Setup environment
|
||||
cp config/.env.example .env
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue