Skip to content

Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
neelTripathi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 26 additions & 53 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,80 +1,53 @@
# FP4-proposal
Project Proposal is due 2015-04-08 at 8am

Produce a plan for your final project, and prepare an in-class presentation.

Ask questions, as always, [on piazza!][piazza]

## Written Proposal Instructions

Teams will submit ONE written proposal, with sections that each member has done individually detailing their proposed contributions. The submission will be on github, as a pull request of this very file. Below is a template proposal report.

You should be proposing something that you have high confidence that you can achieve, and the proposal should project that confidence.
The proposal should be no longer than necessary, but long enough to include critical detail. Three pages is appropriate. Diagrams are welcome.

Remember, you can do some neat [formatting things with Markdown.][markdown]

## In-Class Presentation Instructions
Teams will each deliver an in-class presentation. **Presentations will be Wednesday, April 8** (and Friday, April 10 as necessary). The presentation material is due on April 8 by 9 am for everybody. [See piazza for full schedule.][piazza]

Your team will have two minutes to present. Create presentation with two or three slides. Make the slides in google drive, and share the public-viewable link at the bottom of this report. The day of presentations, I'll have the list of links on the display computer, so each team can simply click their link and begin.

(Template follows. You may delete this line and all above it. Please edit the following template to create your report.)

# Project Title: title here (10 words maximum)
# Project Title: NoteRad
### Problem Statement
Describe your problem, and why it is interesting.
We would like to design a text editing application along the lines of Notepad but better.

### Problem Analysis
Explain what approaches from class you will bring to bear on the problem. Be explicit and succinct.
Data Abstraction - We will be using pre-existing library procedures in our design without knowing exactly what code is hidden under the hood.
Object Oriented Programming - We will be constructing objects and using encapsulated member procedures and attributes in designing the application.

### Data set or other source materials
If you will be working with existing data, where will you get those data from? (Dowload it from a website? access it in a database? create it in a simulation you will build....)

How will you convert that data into a form usable for your project?

Do your homework here: if you are pulling data from somewhere, actually go download it and look at it. Explain in some detail what your plan is for accomplishing the necessary processing.

If you are using some other starting materails, explain what they are. Basically: anything you plan to use that isn't code.
Our project doesn't involve any datasets or other materials, at least not that we know of right now. As such, we will be relying solely on racket libraries.

### Deliverable and Demonstration
Explain exactly what you'll have at the end. What will it be able to do at the live demo?

What exactly will you produce at the end of the project? A piece of software, yes, but what will it do? Here are some questions to think about (and answer depending on your application).

Will it run on some data, like batch mode? Will you present some analytical results of the processing? How can it be re-run on different source data?

Will it be interactive? Can you show it working? This project involves a live demo, so interactivity is good.
Our end-product will be a text editing application that will have the following functionality:
- Enter and save text to a file
- Copy/Paste text into the application
- Word wrapping - the process of breaking a section of text into lines such that it will fit in the available width of a page

For the live demo, we will demonstrate each one of the features described above. The application will be interactive as that is the nature of text editing applications.

### Evaluation of Results
How will you know if you are successful?
If you include some kind of _quantitative analysis,_ that would be fantastic.
We will know if our application is successful if it meets the following criteria:
- Handle entering text into the text pane using a keyboard
- Handle copying/pasting text to and from the text pane
- Handle word wrapping
- Handle saving text to a file

## Work Plan and Schedule
Explain how you will go from proposal to finished product. Write your general plan here.
There are three deliverable milestones to explicitly define, below. The nature of deliverables depend on your project, but may include things like processed data ready for import, core algorithms implemented, interface design prototyped, etc.

You will be expected to turn in code, documentation, and data (as appropriate) at each of these stages, so take care in writing concrete steps for your schedule.

In this general plan, and in the deliverables below.

### First Milestone (04-13)
What exactly will be turned in on this day?
We will create the GUI object for the text editor i.e. the window, text pane, and menus.

### Second Milestone (04-21)
What exactly will be turned in on this day?
We will add the text input functionality to the GUI so that the application can handle inputting text from the keyboard and saving text to a file.

## Group Responsibilities
Here each group member gets a section where they, as an individual, detail what they are responsible for in this project. Each group member writes their own Responsibility section. Include the milestones and final deliverable.

### Susan Scheme
will write the....
### Neel Tripathi
I will work on the rudimentary framework for the GUI part of the application i.e. creating a window frame, and text pane.

### Muthuraman Lakshmanan
I will work on the inside of the GUI frame such as creating different tabs for the application so that user can use those tabs to interact with the application.

### Leonard Lambda
will work on...
### Ajay Kumar
I will work on inputting data into application and copy/paste of text in the application.

## Proposal Presentation Link
insert your google presentation public link here, so with one click it will open up in the browser and you can present.
[Presentation Link](https://docs.google.com/presentation/d/1y-HKkfS6fuV-WPuymQmavc9O-lpM0Ml7VCgf8lZBz8c/edit?usp=sharing)

<!-- Links -->
[piazza]: https://piazza.com/class/i55is8xqqwhmr?cid=453
Expand Down