Skip to content

Update README.md with sentence structures #1

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md with sentence structures #1

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
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,42 @@
# Object-Oriented-Design

Projects
## Projects
************************************************************************************************************************************************************************************************************
InMemoryDB - C++
In This project I developed a Non SQL database using unordered map and c++ template classes, this database has api's for CRUD operations.
### InMemoryDB - C++

In This project I developed a Non-SQL database using unordered map and c++ template classes. This database has api's for CRUD operations.
The data stored in the database can be persisted to and from an xml file.

************************************************************************************************************************************************************************************************************

Code Analyser - C++
Code analysis consists of extracting lexical content from source code files, analyzing the code's syntax from its lexical content, and building a Type Table (TT) or an Abstract Syntax Tree (AST) that hold the results of our analysis. It is then fairly easy to build several backends that can do further analyses on the data held in TT or AST to construct code metrics, search for particular constructs, or some other interesting features of the code.
### Code Analyser - C++

Code analysis consists of extracting lexical content from source code files, analyzing the code's syntax from its lexical content, and building a Type Table (TT) or an Abstract Syntax Tree (AST) that holds the results of our analysis. It is then fairly easy to build several backends that can do further analysis on the data held in TT or AST to construct code metrics, search for particular constructs, or some other interesting features of the code.
This project takes in source code files of c++ and c# project.

************************************************************************************************************************************************************************************************************
Code Publisher - C++
### Code Publisher - C++

Code publisher publishes the source code files of projects as web pages with embedded child links. Each link refers to a code file that the displayed code file depends on.
Code Publisher creates .Html files for each source code file.
Code Publisher creates .html files for each source code file.

************************************************************************************************************************************************************************************************************
Remote Code Publisher - C++
### Remote Code Publisher - C++

A Code Repository is a Program responsible for managing source code resources, e.g., files and documents. A fully developed Repository will support file persistance, management of versions, and the acquisition and publication of source and document files. A Remote Repository adds the capability to access the Repository's functionality over a communication channel, e.g., interprocess communication, inter-network communication, and communication across the internet.

This project focuses on the publication functionality of a Remote Repository. This project includes a remote code publisher, local client, and communication channel that supports client access to the publisher from any internet enabled processor.
This project focuses on the publication functionality of a Remote Repository that includes a remote code publisher, local client, and communication channel that supports client access to the publisher from any internet enabled processor.

The communication channel will use sockets and support an HTTP like message structure.

The channel supports:
### The channel supports:

HTTP style request/response transactions
One-way communication, allowing asynchronous messaging between any two endpoints that are capable of listening for connection requests and connecting to a remote listener.
Transmission of byte streams that are set up with one or more negotiation messages followed by transmission of a stream of bytes of specified stream size.


The Remote Code Publisher :
### The Remote Code Publisher :

Support publishing web pages that are small wrappers around C++ source code files.
Accept source code text files, sent from a local client.
Expand All @@ -42,7 +45,7 @@ Support HTML file creation for all the files in a specified repository folder, i
Delete stored files, as requested by a local client.


Clients of the Remote Code Publisher provides a Graphical User Interface (GUI) with means to:
### Clients of the Remote Code Publisher provides a Graphical User Interface (GUI) with means to:

Upload one or more source code text files to the Remote Publisher, specifying a category with which those files are associated.
Display file categories, based on the directory structure supported by the Repository.
Expand Down