https://github.com/vpj/annotate

Annotate python source code
https://github.com/vpj/annotate

Last synced: 3 months ago
JSON representation

Annotate python source code

• Host: GitHub
• URL: https://github.com/vpj/annotate
• Owner: vpj
• License: mit
• Created: 2019-08-25T10:17:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-09T11:07:41.000Z (almost 5 years ago)
• Last Synced: 2024-11-29T18:49:52.540Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 722 KB
• Stars: 69
• Watchers: 4
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        


  



## What is it?

It is a simple web app that lets you write Markdown side notes on your code,

without making changes to the source files.

The idea is to write notes and comments outside the code so that code stays

 clean, short, and readable.

Notes are matched based on similarity when the code changes.

The matching algorithm might need improvements.

We intend to use it for  personal note taking to understand code,

writing [tutorials](http://blog.varunajayasiri.com/ml/transformer.html),

and for collaboration.

### Clone and install

```bash

git clone [email protected]:vpj/annotate.git

cd annotate

git submodule init

git submodule update

./install.sh

```

To update run a git update

```bash

cd annotate

git pull

git submodule update

./install.sh

```

### Starting the server

Navigate to the path of the project and run the following command to start the server.

```bash

annotate

```

### Example

[Annotation of Lab sample](http://blog.varunajayasiri.com/ml/lab3/#samples%2Fmnist_loop.py)