Skip to content

Commit 85396bb

Browse files
authored
Merge pull request #152 from UCSDOalads/develop
Update format for README.md
2 parents 8bb6d14 + 3bf4518 commit 85396bb

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

README.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,9 @@ git clone https://github.com/UCSDOalads/JavaSketchPad.git
2121
cd JavaSketchPad
2222
```
2323

24-
## Contributing
25-
26-
Please read “How to work on this project?” for details on our code of conduct, and the process for submitting pull requests to us.
27-
28-
## Authors
29-
30-
See also the list of [contributors](github.com/UCSDOalads/JavaSketchPad/graphs/contributors) who participated in this project.
31-
32-
## Acknowledgments
33-
UCSD CSE B260 lab
34-
3524

3625
## User Interface Introduction
37-
26+
![alt text](https://github.com/UCSDOalads/JavaSketchPad/blob/demoImage/demo%201.png)
3827
### Menu bar:
3928
Contains all the functionalities that you can use on JavaSketchPad, mainly including Data (Input/Output Box, Annotations, etc), Lazy (Java class, method, etc), Edit (Zoom, font, etc), File (e.g. c.xml), Script (same as the “:” commands to quickly add objects). Among them, Generate, Developer, and View are deprecated or under-development.
4029

@@ -54,6 +43,16 @@ Class (C): create a Java class constructor that can be used to create its method
5443
InputBox (I): A data input box that can be updated with double click or a click on menu bar (Data -> InputBox -> Update). It can also be connected to the left dots of method to pass in argument for methods.
5544
OutputBox (O): A data output box that can be updated with a click on menu bar (Data -> OutputBox -> Update), but only after it is connected to the right dots of method and all the left dots are connected with data.
5645

46+
### MUST READ THIS!
47+
For any class other than java.lang.String class, please use a Constructor that takes in a ***String*** type data to initialize the value to be the corresponding type before constructing lines.
48+
49+
E.g.:
50+
![alt text](https://github.com/UCSDOalads/JavaSketchPad/blob/demoImage/demo%202.png)
51+
52+
53+
## Contributing
54+
55+
Please read “How to work on this project?” for details on our code of conduct, and the process for submitting pull requests to develop branch.
5756

5857
## Open Source Code: Package Description
5958

@@ -87,3 +86,25 @@ ui.helper.historyui.undoredoLog: generate log for undo/redo Log
8786
ui.helper.methodinput: implements the method input functionality. The package contains a method input frame and a method searching engine.
8887
ui.icons: icons used in the program
8988
```
89+
90+
91+
## Authors
92+
93+
See also the list of [contributors](https://github.com/UCSDOalads/JavaSketchPad/graphs/contributors) who participated in this project.
94+
```
95+
(in alphabetical order)
96+
Original Author/ ex-Project Lead: Zhibo Chen.
97+
Project Lead: Cheng Gong
98+
(UI) User Interface Lead: Kaijie Cai.
99+
UI members: Zhien Ke.
100+
(ID) Interactive Design Lead: Muyuan Chi.
101+
ID members: Zhongyu Chen, Yaobang Deng, Xiangyi Gong, Xiaoquan Jiang, Kent, Feng Shan, Tan Su.
102+
(BE) Back End Lead:           Yidong Luo.
103+
BE members: Sean Z, Tianyi Zhang.
104+
```
105+
106+
## Acknowledgments
107+
```
108+
UCSD CSE B260 lab
109+
Helen, Zhening Huang, Mossaka, Jiheng Wang, Tony Yang, and any other who support or contribute to this project.
110+
```

0 commit comments

Comments
 (0)