update readme

This commit is contained in:
Fabian Posch 2024-01-05 12:12:22 -05:00
parent 92cf285b72
commit cacde8ae88

View file

@ -1,17 +1,12 @@
# Actsim Cluster Agent # Actsim Cluster Agent
## Usage Database frontend for the `actsim` simulator. This tool works in conjunction with `act-deploy` and its associated database.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. If you want to run a lot of distributed simulations, this is how to do it.
## Roadmap ## Roadmap
- [ ] Should be defined once the base implementation stands - [ ] Run simulations from the database
## Contributing
- [ ] Should be written once the base implementation stands
- [ ] Add code styling guidelines
## Authors and acknowledgment ## Authors and acknowledgment