https://github.com/devbyray/tech-report-temp
A nice Markdown file for Tech reports
https://github.com/devbyray/tech-report-temp
Last synced: about 1 year ago
JSON representation
A nice Markdown file for Tech reports
- Host: GitHub
- URL: https://github.com/devbyray/tech-report-temp
- Owner: devbyray
- Created: 2014-03-07T13:13:10.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-12-10T17:36:29.000Z (over 11 years ago)
- Last Synced: 2025-01-12T10:11:45.737Z (about 1 year ago)
- Homepage:
- Size: 195 KB
- Stars: 6
- Watchers: 2
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#README first!
This template can be used for writing easy and simple technical reports. For writing a techreport you use Markdown. And you can use this template i made for free :-). "**Markdown files can be opened and edited with every simple text editor!**"
If you clicked on the template file in GitHub than you see the result of an rendered Markdown file. So if you want to use the file? Check the details below!
#Index
- [How to use the Tech Report template](#how-to-use-the-tech-report-template)
- [What is Markdown?](#what-is-markdown)
- [Questions](#questions)
- [Helpfull guidelines](#helpfull-guidelines)
- [Use the Template with an supereasy generator](https://github.com/j3lte/project-reports) by [@j3lte](https://github.com/j3lte)
# How to use the Tech Report template
**Developer/Technical people version**
For the people that know how to use Git with the commandline. Follow these instructions:
1. Install [Git](http://git-scm.com/) on your computer.
2. Go to the folder (in the commandline/terminal) where you want to store all your Technical reports.
3. Add the git clone command with the url in your commandline/terminal
git clone https://github.com/raymonschouwenaar/tech-report-temp.git
4. Now you have a clone of my GitHub repo on your computer.
5. I want to advice you to copy the folder and rename the date, your projectname and your First and lastname. So if there is an update for the template you can go to the folder (in the commandline/terminal) and type git pull so the template will be updated.
6. To check if there is an update type git status in the template folder.
**Non or less technical people version**
For the people that dont't know how to use Git with the commandline. Follow these instructions:
1. If you have an GitHub account and you have installed the Software of GitHub. You only have to click on the button "**Clone in Desktop**" on the right column at the bottom.
2. If you didn't have a GitHub account or for some reason you want to download an ZIP file with all the files in it. Just click on "**Download ZIP**" on the right column at the bottom.
# What is Markdown
Markdown is an plain text format syntax. It can be easily be converted to HTML.The most Word documents has a lot of "trashy" code when you use it for pasting in WordPress or some other CMS.
**Here are some links to find more information about Markdown and how to use it:**
- [Markdown info @ Wikipedia](http://en.wikipedia.org/wiki/Markdown)
- [Markdown How to use it](https://daringfireball.net/projects/markdown/)
- [Markdown Syntax info](https://daringfireball.net/projects/markdown/syntax)
- [Tutorial to learn Markdown](http://www.markdowntutorial.com/)
- [Markdown the Ins & Outs](http://code.tutsplus.com/tutorials/markdown-the-ins-and-outs--net-25482)
- [Check the visual rendering of your Markdown file in Chrome with this Chrome extension](https://chrome.google.com/webstore/detail/markdown-preview/jmchmkecamhbiokiopfpnfgbidieafmd)
# Questions
For questions, send me a tweet at [@rsschouwenaar](https://twitter.com/rsschouwenaar) or [create an new issue](https://github.com/raymonschouwenaar/tech-report-temp/issues)
# Helpfull guidelines
**iFrame/Youtube display's page or video player in the <pre></pre> tags**
If you have a problem with an iFrame or an Youtube iframe code between the <pre></pre> tags. Than i've got this solution, so the code will not be executed trough the browser. But will properly displayed as code.
1. Copy your iFrame code
2. Go to [htmlentities.net](http://htmlentities.net/)
3. Paste your code in the input textarea
4. Click on the "encode" button
5. Copy the code from the result textarea
6. Paste it in your Tech report file between the <pre></pre> tags.
7. If it doesn't work? Let me know! :-)