Twincling Scano Project

Overview

Vision Scano is a (S)ource (C)ode (An)n(o)tator. Scano facilitates core engineering activities such as commenting the code, logic and algorithm notes, code review sessions, tags like - bug, tracker, performance, security, cleanup and stc (subject to change).
License Apache Software License 2.0 (ASL 2.0)
Technology PHP, Cross ref, SQLite, AJAX, XML
Status Under Development

User Documentation

FAQ

Q: I am a student/professional with a keen interest in programming and contributing to open source. Can I contribute to Twincling Scano?

A: Of course! One of the purpose of the projects at the Twincling Technology Foundation is to encourage students and professional to contribute to open source projects. To know how to get involved and start working, see the "How to Contribute" question below.

Q: Source code annotator? What in the world is that? Did you just make that up?

A: We'll be honest, we made up the name on our own! The concept behind Scano is to seperate code and informative data. Normally, you would write comments inside your code to give extra data to readers of your code. With Scano, you can take a clean piece of code, with no comments in it, and add extra information in the form of annotations from within the Scano framework. This way, you have effectively seperated code and informational parts. This is similar to what CSS did to HTML! Pretty big!

Q: How can I start contributing to Twincling Scano?

A: You could start off by reading the archives on the mailing list link below. Once you have a fair idea of what we are planning and what progress has taken place so far, you can start looking at the bug/artifact tracker (see link below) consisting of the planned and requested features. Simply start working on of the features and submit it to us. You are also requested to subscribe to the mailing lists and post any queries and problems you encounter.

Q: Who are the people working on Twincling Scano currently

A: Currently the following people are working on Twincling Scano:

Manohar Vanga - Prototype Development
Vijaylakshmi - Client Tier Development

We also have a lot of common modules being developed for all the Twincling projects by the following people

Mukund Deshpande - OpenID Authentication Module
Pachunuri Anush - Sorter Component

Q: Where can I interact with project members?

A: You can always drop us a mail on the project mailing list (recommended). Additionally you can check if there is anyone around in the Twincling IRC. You can catch us in there on weekends or evenings (Indian Standard Time).

Developers Guide

Currently we don't have a release, so you will have to set up the entire framework yourself. To understand what Scano does you will need to set up the following components:

A complete LAMP (Linux, Apache, MySQL, PHP) stack
LXR Source Code Cross Indexer

The core of Scano uses a modified version of the LXR cross referencing engine. We also have a AJAX Client in development. To start developing, you could start by learning about the following: