Skip to content

Example readme #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cmonagle merged 2 commits into from
May 13, 2020
Merged

Example readme #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0c5245
Example readme
cmonagle May 12, 2020
ac2cdb5
Adds note on environment variables
cmonagle May 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions documentation/README.ex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Repository title

> Provides an example readme template to bootstrap documentation.

Start with one sentence explaining what the repository does. Avoid mentioning the technology used, its rationale, or tech jargon. This sentence should be understandable by a non-technical audience.

## Development

Describe the development environment. Include basic instructions--does this repository prefer `npm ci` or `npm i`? Does prettier run on save? Any special settings or extensions you should set up in your IDE?

Include any environment variables or configuration required.

If you're not sure where to start, consider explaining the npm scripts that might be relevent for getting a development environment

@juanborre juanborre May 13, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably here we should add the environment variables needed to run it or to modify its behaviour.

@cmonagle cmonagle May 13, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, thank you!


## Dependencies

Be sure to include any system level dependencies, even if they are shared with many projects. Do I need Transit APIs running? Redis? Docker?

## Deployment

How can I put this on staging or production? If automated, place a link to the cloud build trigger.

## Organisation

Include a quick overview of how the project is organised. If it follows a pattern, include a link to the Wikipedia article (ie: "This project is organised following the principles of [Domain Driven Design](), where it makes sense").

## Resources

Are you consuming an entity that follows a documented specification? Include a link to the specification (ie gbfs or gtfs).

## Final notes

- Write in simple English.
- Prefer lists when appropriate.
- Include links to third party resources.