Brief introduction to the project. Tags for build status and other relevant information. Links to additional resources such as a wiki or other readmes.
Short description as to why the project was created in the first place.
How to run the project. Keep this as short as possible, including only cloning, bare minimum configuration (if any), and running a start script. May include serperate links to stable and latest development releases.
Be sure to wrap terminal commands or bits of code that are one line with a ( ` ), and/or three ( ``` ) for bits of code that are multiple lines. This takes advantage of .md's ability to format code, which makes finding important snippets of code easier. EXAMPLE:
- First create an .env file with the following fields:
GOOGLE_VISION_API_KEY="vision key"
GOOGLE_MAPS_API_KEY="maps key"
ANOTHER_ENV_VAR="value"
- Then open Terminal, and use
npm startto start the server.
Talk about
- development environment
- potential bugs (link to issues)
- project aliases
- project structure & where to find code
Describe the specific features of the application in an abstract level. Take the reader through the user interface of the application. Screenshots of the project may be added.
If a project does not need maintainance or additional developers indicate that here. Otherwise talk about how new developers can get onboarded and once onboarded what they need to know to be caught fully up to speed.
Talk about
- Software architecture
- Deployment
- Access credentials and permissions
- Development best practices
- Everything from the What section in Documentation
- Harsha Srikara
- David Richey
- Aliah Shaira De Guzman
- Sivam Patel
- Kendra Huang
- Jafar Ali
- Other contributors
- Include any resources and their links that helped with your project's success
- Articles
- Documentation
- Examples
Sometimes you may have additional questions. If the answer was not found in this readme please feel free to reach out to the Director of Development for ACM
We request that you be as detailed as possible in your questions, doubts, or concerns to ensure that we can be of maximum assistance. Thank you!
