Skip to content

Commit 30ca6c4

Browse files
committed
updates README.md
1 parent db68cdd commit 30ca6c4

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,18 @@
22
The Code Time Machine is a lightweight IDE plugin which uses visualization techniques to depict the history of any chosen file augmented with information mined from the underlying versioning system. Inspired by Apple’s Time Machine, this tool allows both developers and the system itself to seamlessly move through time.
33

44

5-
For known issues, please check [the issues](https://github.com/Emadpres/CodeTimeMachine/issues).
5+
## Installation
6+
### Binary
7+
To install using pre-built binary, first download [the latest release]. Then, go to IntelliJ IDE > Preference > Plugin > install plugin from Hard.
8+
9+
### Source code
10+
First clone the project. Follow the [Setting Up a Development Environment] guideline to setup the IntelliJ IDE for plugin development. Now you should be able to compile the project (requires Java 1.8) and run it. In the end, deploy the project by following the [Deploying a Plugin] tutorial.
11+
12+
## Issues
13+
For known issues, please check [the issues].
14+
15+
16+
[the latest release]:(https://github.com/Emadpres/CodeTimeMachine/releases/latest)
17+
[Setting Up a Development Environment]:(http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started.html)
18+
[Deploying a Plugin]:(http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/deploying_plugin.html)
19+
[the issues]:(https://github.com/Emadpres/CodeTimeMachine/issues)

0 commit comments

Comments
 (0)