Commit 338dff43 authored by Wenyuan  Cui's avatar Wenyuan Cui
Browse files

Update README.md

parent 9c8c2686
Loading
Loading
Loading
Loading
+5 −19
Original line number Diff line number Diff line
@@ -44,29 +44,15 @@ jMonkeyEngine can provide the customized gravity. The elasticity of triangle edg


## Usage
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.
Unzip the file and add command line configuration when running: 

## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
./bounce --image [PATH TO IMAGE FILE] --speed [INITIAL SPEED] --dir [XX], [YY], [ZZ]

## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
For example:

## Contributing
State if you are open to contributions and what your requirements are for accepting them.
"./bounce --image src/main/java/bouncingshape/sphere_triangles.txt --speed 100 --dir 1, 0, 0" 

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.

## License
For open source projects, say how it is licensed.

## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
If the program runs successfully once and crash in the second time, try refresh the cache.

## Code
 Link to the branch containing all complete: https://agile.bu.edu/gitlab/ec504/ec504_projects/group5.git