Skip to content

Commit e417f1f

Browse files
committed
updated ReadMe v2
1 parent 80f86a6 commit e417f1f

File tree

3 files changed

+54
-20
lines changed

3 files changed

+54
-20
lines changed

README.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<h1 align="center">
2-
<img width="235 height ="235" src="src/assets/right_sidebar325x325.svg">
2+
<img width="235 height ="235" src="src/assets/ReadMe325x325.svg">
33
</h1>
44

55
<p align="center"><b>Prototyping Development Tool for Vue Developers</b></p>
@@ -23,27 +23,21 @@
2323
![Quasar](https://img.shields.io/badge/Quasar-16B7FB?style=for-the-badge&logo=quasar&logoColor=black)
2424
![Prism.js](https://img.shields.io/badge/Prism.js-A81C7D?style=for-the-badge)
2525
![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)
26-
![Vuex](https://img.shields.io/badge/Vuex-4A154B?style=for-the-badge)
2726
![Babel](https://img.shields.io/badge/Babel-F9DC3e?style=for-the-badge&logo=babel&logoColor=black)
2827
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
29-
![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
3028
![Vuetensils](https://img.shields.io/badge/Vuetensils-00897B?style=for-the-badge)
3129

3230
## Table of Contents
3331

3432
- [Installation](#installation)
35-
- [Dev Installation](#dev-installation)
36-
- [WSL Installation](#updated-WSL-Installation-and-Configuration-Guide)
3733
- [How to use OverVue](#how-to-use-OverVue)
38-
39-
4034
- [Changelogs](#changelogs-(recent))
4135
- [How to contribute](#contributing)
4236
- [Authors](#contributors)
4337

4438
## Installation
4539

46-
To download the production version for windows or mac, please visit https://www.overvue.org
40+
To download the production version, please visit https://www.overvue.org
4741
<hr>
4842

4943
### Dev Installation
@@ -144,29 +138,37 @@ This streamlined approach helps you focus on building and visualizing your Vue.j
144138

145139
![AddStateActions](./src/assets/readme/AddStateActions.gif)
146140

147-
- When finished creating, view your code preview under the code preview tab and you can export to a file location of your choice. Below is the exported file structure:
141+
- When finished creating, view your code preview under the code preview tab and you can export to a file location of your choice. Below is the exported file structure ('*' = only in typescript format, '**' = only in test format:
148142

149143

150144
```
151145
public/
152-
index.html
153146
src/
154147
assets/
155148
components/
156-
UserCreatedComponent1.vue
157-
UserCreatedComponent2.vue
149+
(YourNewComponent1.vue)
150+
(YourNewComponent2.vue)
158151
...
159152
router/
160-
index.js
153+
index.js/ts
154+
store/
155+
index.js/ts
161156
views/
162157
HomeView.vue
163-
UserCreatedRouteComponent1.vue
164-
UserCreatedRouteComponent2.vue
158+
(YourNewRoute1.vue)
159+
(YourNewRoute2.vue)
165160
...
166161
App.vue
167-
main.js
168-
babel.config.js
162+
main.js/ts
163+
tests/
164+
units**
165+
.eslintrc.cjs
166+
env.d.ts*
167+
babel.config.js/ts
168+
jest.config.js/ts**
169+
index.html
169170
package.json
171+
vite.config.js/ts
170172
```
171173

172174
- To get a better look at the features and how to use OverVue, take a look at the in-app tutorial!
@@ -189,8 +191,6 @@ package.json
189191
<li> Refactored codebase, clean-up unused old code, unused files for optimization of Electron build </li>
190192
<li> Optimize images displayed to take a smaller footprint and increase speeds or older systems </li>
191193
<li> Slack and Github OAuth feature has been hidden as currently the feature is not working, and is not seeing much use either </li>
192-
<li> </li>
193-
<li> </li>
194194

195195

196196
<br>
@@ -202,7 +202,6 @@ package.json
202202

203203
<h4><strong>Known Bugs</strong></h4>
204204
<li> Slack OAuth not working (currently disabled) </li>
205-
206205
<li> Canvas tree can only be moved with arrow keys </li>
207206
<li> Not necessarily a bug, but certain peer dependencies are not updated by their maintainers (ie tesing vue with jest). To update to a new dependency, this requires ample amount of time that we unfortunately did not have</li>
208207

src/assets/ReadMe325x325.svg

Lines changed: 21 additions & 0 deletions
Loading

src/assets/tileIcon.svg

Lines changed: 14 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)