Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 880 Bytes

README.md

File metadata and controls

33 lines (24 loc) · 880 Bytes
Raw

Carloop Docs

This is the repository of all documentation for Carloop Hardware and Software

Contribute

  • Commit new content in Markdown files, additional images, etc
  • Push to GitHub
  • The changes will be live at docs.carloop.io momentarily

Local development

  1. Clone Repo
git clone [email protected]:carloop/docs.git
  1. Run a web server in the local directory
ruby -run -e httpd
  1. Once your server is running, open up a browser and type in the URL:
http://localhost:8080/

How to format Markdown files:

Here is a great guide that shows you the tips and tricks to format Markdown files to look nice: https://daringfireball.net/projects/markdown/syntax

License

Copyright 2017 1000 Tools Inc. Distributed under the Creative Commons Attribution-ShareAlike 4.0 International license.