diff --git a/README.md b/README.md index 1f22056..4d1dcba 100644 --- a/README.md +++ b/README.md @@ -10,4 +10,13 @@ Designed to create a space free from boundaries and sharp edges, tailored to the ![Shows a desktop with a window with curved corners and no border in the center displaying a mountain image.](Assets/Screenshots/screenshot_001.jpg?raw=true "Screenshot One") ![Shows a desktop with two windows with curved corners and no border. One window on the left of the desktop contains a mountain image. The window on the right contains a wheat field with a hill in the background.](Assets/Screenshots/screenshot_002.jpg?raw=true "Screenshot Two") -![Shows a desktop with three windows all overlapping each other. One window contains a street scene with a small food business and people outside. The second presents a narrow street with a tree at the end of it. The last window holds an image of a riverbank with a park and buildings in the distance.](Assets/Screenshots/screenshot_003.jpg?raw=true "Screenshot Three") \ No newline at end of file +![Shows a desktop with three windows all overlapping each other. One window contains a street scene with a small food business and people outside. The second presents a narrow street with a tree at the end of it. The last window holds an image of a riverbank with a park and buildings in the distance.](Assets/Screenshots/screenshot_003.jpg?raw=true "Screenshot Three") + +---- + +## Development +Minimal Image Viewer has been built in Electron. Currently the ```main``` branch can be used for forking and working on. All necessary code can be found in the ```App``` folder. +To begin ensure that you have ```Yarn``` installed. Then type into your terminal: +```yarn``` +and +```yarn run start```