Skip to content

Latest commit

 

History

History
90 lines (71 loc) · 3.6 KB

template1.md

File metadata and controls

90 lines (71 loc) · 3.6 KB
Raw
theme transition center height
black
fade
false
800
<style> .reveal h1, .reveal h2, .reveal h3, .reveal h4, .reveal h5 { text-transform: none; } .reveal p { text-align: left; } .reveal ul { display: block; } .reveal ol { display: block; } .reveal p:has(> img){ text-align: center; } h3 { border-bottom: 2px solid yellow; padding: 10px; } </style>

How to write a technical report

Git and Terminal

You need to know how to use Git and a terminal to work on the project. The related tutorials are in the book Scientific Computing for Physicists. The following are the links to the tutorials:

GitHub Copilot + Markdown for technical writing

This is a workflow for setting up AI-assisted technical writing using Github Copilot and Markdown.

Step 1: Setup Markdown Editor

  1. Go to VS Code website and download the latest version, then install & open VS Code.
  2. Add the following VS Code extensions. To add an VS Code extension, please click the Extensions button in the left side bar, search for the extension name and click the Install button.
  1. Create a new file and save it as test.md. Then, click the Preview button {width=50px} in the top right corner.
  2. Edit the markdown file. You can learn markdown from here. Math equations can also be rendered. For example, the following code 
    $$
\frac{1}{2}
$$
    will be rendered as $$ \frac{1}{2} $$

Image

{width=60%}

Step 2: Setup GitHub Copilot

  1. Go to the GitHub website and sign up for a free account.
  2. Install the GitHub Copilot extension. GitHub Copilot requires you to connect with your Github account. You can also use it for free if you are a student (check out) or you will be charged for using it. Learn more from this YouTube video.
  3. You might need to activate the GitHub Copilot extension by clicking the Activate ({width=50px}) button in the bottom right corner of the VS Code window to make it work. Then you can type some text in the editor and press Tab to confirm the suggestion from Github Copilot.

Step 3: Using GitHub/GitLab to host your markdown (optional)

GitHub/GitLab is a code hosting platform for version control and collaboration. It allows you to

  • sync files across different devices,
  • work together with others from anywhere, and
  • preview markdown files in the browser.

You can learn GitHub from the YouTube video or the official guide. The GitLab workflow that we will use is similar.